Class FSCMINDBREEZEINSIGHT@1.1001:InsightApp

This class is used for defining an Insight App using the Mindbreeze Insight App Designer.

see https://at.cloud.fabasoft.com/search/apps/designer/

Class Hierarchy

Object > ContentObject > InsightApp

Properties

Type	Property	Name
LanguageStringList[]	mlname	Multilingual Name
Object[]	objuseablefiles	Files
Object[]	objuseableprimaryrelated	Contained in
ObjectClass[]	objuseableself	Current Document

Actions

Return Type	Signature
boolean	CanReleaseTemplate( out retval boolean canrelease)
boolean	CanReplaceDocument( out retval boolean canreplace)
object	GetDraftTemplate( out retval object drafttemplate, optional boolean includeself)
boolean	IsDraftTemplate( out retval boolean isdrafttemplate)
object	ReleaseTemplate( out retval object releasedtemplate, optional boolean keepoldrelease, optional dictionary additionalsettings)

Properties

Multilingual Name (COOSYSTEM@1.1:mlname)

Defines the multilingual name of the object. It stores one name for each supported language.

Explanation:
This field defines the multilingual name of the object.

unique LanguageStringList[] COOSYSTEM@1.1:mlname

Files (FSCFOLIO@1.1001:objuseablefiles)

Defines the usage restrictions of templates and text modules.

Explanation:
Defines the type of files in which the current object can be used. You can do this using either the object class or the category of the file. If object classes and categories are specified together, the file must have a defined object class and a defined category.

unique Object[] FSCFOLIO@1.1001:objuseablefiles

Additional Information

Object Classes Allowed: ObjectClass, TemplateCategory, ComponentTemplateCategory

Contained in (COOSYSTEM@1.1:objuseableprimaryrelated)

The classes and categories of the objects which have a direct relationship to an object, used for template management.

Explanation:
Defines the folder types in which the current object can be used. This can either be done using the object class or the category of the folder. If object classes and categories are specified together, the folder must have a defined object class and a defined category.

unique Object[] COOSYSTEM@1.1:objuseableprimaryrelated

Additional Information

Object Classes Allowed: ObjectClass, TemplateCategory, ComponentTemplateCategory

Current Document (COOSYSTEM@1.1:objuseableself)

The classes which have a direct relationship to an object, used for template management.

Explanation:
Defines the categories and object classes of documents in which the current object can be used.

unique ObjectClass[] COOSYSTEM@1.1:objuseableself

Additional Information

Object Classes Allowed: ObjectClass, TemplateCategory, ComponentTemplateCategory

Actions

COOTC@1.1001:CanReleaseTemplate

Check if the current user is allowed to release a template or to withdraw the release.

boolean COOTC@1.1001:CanReleaseTemplate(
out retval boolean canrelease)

Name	Description
canrelease	the result;

FSCFOLIO@1.1001:CanReplaceDocument

Action to check if the object can be replaced.

boolean FSCFOLIO@1.1001:CanReplaceDocument(
out retval boolean canreplace)

Name	Description
canreplace	the result

COOTC@1.1001:GetDraftTemplate

Gets the draft version of the template. The action can be called both on the draft version and on the release version of a template.

object COOTC@1.1001:GetDraftTemplate(
out retval object drafttemplate,
optional boolean includeself)

Name	Description
drafttemplate	the draft template
includeself	if set to true and the current object is a draft template (see `COOTC@1.1:objistemplate`) it will return himself

COOTC@1.1001:IsDraftTemplate

Checks if the template is a draft which can be released.

If the release mechanism is to be used for an object class, then this action can be implemented for example with: isdrafttemplate = cooobj.IsUsable() && !cooobj.GetDraftTemplate();

boolean COOTC@1.1001:IsDraftTemplate(
out retval boolean isdrafttemplate)

Name	Description
isdrafttemplate	the result

COOTC@1.1001:ReleaseTemplate

Action to release a template. A released template can be instantiated.

object COOTC@1.1001:ReleaseTemplate(
  out retval object releasedtemplate,
  optional boolean keepoldrelease,
  optional dictionary additionalsettings)

Name	Description
releasedtemplate	the released template
keepoldrelease	in case of newly created released template the old release is not deleted
additionalsettings	this dictionary may contain custom informations when calling the action manually to handle user decision e.g to release sub templates