2024 April Release

Class COOSYSTEM@1.1:ObjectClass Permanent link for this heading

This class is the object class for classes derived from the class Object.

Class Hierarchy

Object > ComponentObject > ObjectClass

Direct Subclasses

AspectClass, ClientConfigurationClass, ClientDomainClass, CompoundObjectClass, ContentFormatClass, ContentObjectClass, ObjectAspect, OpenAPIServiceClass, RelationObjectClass, SimpleObjectSearchClass, UseCaseWrapper

Properties Permanent link for this heading

Type

Property

Name

boolean

classabstract

Abstract

AttributeDefinition[]

classattributes

Properties

boolean

classcommon

Commonly usable

boolean

classcompound

Compound

boolean

classprogrammatic

Programmatic Use

ObjectClass[]

classsubclasses

Derived Classes

ObjectClass

classsuperclass

Base Class

LanguageStringList[]

mlname

Multilingual Name

Actions Permanent link for this heading

Return Type

Signature

object

GetDraftTemplate(
  out retval object drafttemplate)

object

GetReleasedTemplate(
  optional boolean checkreleased,
  out retval object releasedtemplate)

boolean

IsCategoryAllowed(
  object category,
  out retval boolean allowed)

boolean

IsCategoryAllowedForClass(
  object category,
  out retval boolean allowed)

boolean

IsTemplateReleased(
  out retval boolean isreleased,
  out optional object releasedtemplate)

Properties Permanent link for this heading


Abstract (COOSYSTEM@1.1:classabstract) Permanent link for this heading

Defines whether the class is abstract. If the value is true, the class is abstract and it is not possible to create an object of this class. If the value is false, the user is able to create an instance of this class. The initial value is false.

boolean COOSYSTEM@1.1:classabstract not null readonly


Properties (COOSYSTEM@1.1:classattributes) Permanent link for this heading

Defines the list of the additional properties of this object class.

unique AttributeDefinition[] COOSYSTEM@1.1:classattributes readonly


Commonly usable (COOSYSTEM@1.1:classcommon) Permanent link for this heading

Marks an object class as a common class. This means that this class is creatable or usable in common locations like in a folder.

boolean COOSYSTEM@1.1:classcommon readonly


Compound (COOSYSTEM@1.1:classcompound) Permanent link for this heading

Defines whether the class is a compound class. Objects of a compound class are listed in the structure layout of the user environment. It is recommended to assign object pointer properties that realize a relation with other objects and a menu to compound classes. The initial value is false.

boolean COOSYSTEM@1.1:classcompound not null readonly


Programmatic Use (COOSYSTEM@1.1:classprogrammatic) Permanent link for this heading

If true instances of this class can only be created using ObjectCreate in program code but not interactively by the user.

boolean COOSYSTEM@1.1:classprogrammatic readonly


Derived Classes (COOSYSTEM@1.1:classsubclasses) Permanent link for this heading

Used to display the derived classes of the class.

ObjectClass[] COOSYSTEM@1.1:classsubclasses readonly volatile


Base Class (COOSYSTEM@1.1:classsuperclass) Permanent link for this heading

Defines the base class of the class. Together with the property classinstsubclass it can be used to insert a new class into the class hierarchy.

ObjectClass COOSYSTEM@1.1:classsuperclass readonly


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.

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

unique LanguageStringList[] COOSYSTEM@1.1:mlname

Actions Permanent link for this heading


COOTC@1.1001:GetDraftTemplate Permanent link for this heading

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)

Name

Description

drafttemplate

the draft template

COOTC@1.1001:GetReleasedTemplate Permanent link for this heading

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

object COOTC@1.1001:GetReleasedTemplate(
  optional boolean checkreleased,
  out retval object releasedtemplate)

Name

Description

checkreleased

Checks the validity of the released template. The object is valid if it is usable and if it is the released template of a design template, or if it is the design template itself in case it is an object that does not need to be released.

releasedtemplate

the released template

COOTC@1.1001:IsCategoryAllowed Permanent link for this heading

Checks if the supplied category is allowed for an object.

boolean COOTC@1.1001:IsCategoryAllowed(
  object category,
  out retval boolean allowed)

Name

Description

category

the category to test

allowed

true if the category is allowed for the object this action is called on

COOTC@1.1001:IsCategoryAllowedForClass Permanent link for this heading

Checks if the supplied category is allowed for an object class.

boolean COOTC@1.1001:IsCategoryAllowedForClass(
  object category,
  out retval boolean allowed)

Name

Description

category

the category to test

allowed

true if the category is allowed for the object class this action is called on

COOTC@1.1001:IsTemplateReleased Permanent link for this heading

Check if a template is already released

boolean COOTC@1.1001:IsTemplateReleased(
  out retval boolean isreleased,
  out optional object releasedtemplate)

Name

Description

isreleased

the result

releasedtemplate