2022 June Release

Class COOTC@1.1001:TemplateCategory Permanent link for this heading

Class Hierarchy

Object > BasicObject > TemplateCategory

Object Class to categorize templates

Properties Permanent link for this heading

Type

Property

Name

AttributeDefinition[]

categoryattributes

Properties

ObjectClass[]

categoryclasses

Applicable for

LanguageStringList[]

mlname

Multilingual Name

Actions Permanent link for this heading

Return Type

Signature

boolean

IsDraftTemplate(
  out retval boolean isdrafttemplate)

boolean

IsTemplateReleaseable(
  out retval boolean isreleaseable,
  out boolean requirereleasedversion)

object

ReleaseTemplate(
  out retval object releasedtemplate,
  optional boolean keepoldrelease,
  optional dictionary additionalsettings)

Properties Permanent link for this heading


Properties (COOTC@1.1001:categoryattributes) Permanent link for this heading

List of all attributes assigned to the category.

unique AttributeDefinition[] COOTC@1.1001:categoryattributes


Applicable for (COOTC@1.1001:categoryclasses) Permanent link for this heading

List of all classes assigned to the category.

unique ObjectClass[] COOTC@1.1001:categoryclasses


Multilingual Name (COOSYSTEM@1.1:mlname) Permanent link for this heading

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

unique LanguageStringList[] COOSYSTEM@1.1:mlname

Actions Permanent link for this heading


COOTC@1.1001:IsDraftTemplate Permanent link for this heading

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:IsTemplateReleaseable Permanent link for this heading

Checks if a template is releaseable, and if a released template is required in a particular context. In the room environment, it is usually the case that a template, which can in principle be released, only needs to be released in certain cases. Templates in an app configuration or a template collection must always be released, while a template of the same object class in an app room does not require release.

boolean COOTC@1.1001:IsTemplateReleaseable(
  out retval boolean isreleaseable,
  out boolean requirereleasedversion)

Name

Description

isreleaseable

the result

requirereleasedversion

this parameter defines if released version of the template is required.

COOTC@1.1001:ReleaseTemplate Permanent link for this heading

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