2022 April Release

Interface CooObject Permanent link for this heading

This interface describes methods available when working with objects.

Methods Permanent link for this heading

Return Type

Signature

void

CallAction(
  transaction transaction,
  object action,
  any[] parameterlist)

void

CallEmbeddedAction(
  transaction transaction,
  object action,
  optional method method)

void

CallMethod(
  transaction transaction,
  method method)

boolean

CheckAccess(
  transaction transaction,
  object accesstype,
  optional boolean showerror)

boolean

CheckAccessEx(
  transaction transaction,
  object accesstype,
  object user,
  optional object rolegroup,
  optional object roleposition,
  optional object clientdomain,
  optional object secclearance)

boolean

CheckAggregateSetAccess(
  transaction transaction,
  object attributedefinition,
  aggregate aggregate,
  optional boolean showerror)

boolean

CheckGetAccess(
  transaction transaction,
  optional object attributedefinition,
  optional boolean showerror)

boolean

CheckGetSecured(
  object attributedefinition,
  optional boolean showerror)

boolean

CheckSetAccess(
  transaction transaction,
  optional object attributedefinition,
  optional boolean showerror)

boolean

CheckSetSecured(
  object attributedefinition,
  optional boolean showerror)

boolean

Compare(
  object object)

void

Delete(
  transaction transaction)

string

GetAddress(
  optional  reserved)

any[]

GetAttribute(
  transaction transaction,
  object attributedefinition)

void

GetAttribute3(
  transaction transaction,
  object attributedefinition)

string

GetAttributeString(
  transaction transaction,
  object attributedefinition,
  optional object language)

string

GetAttributeStringEx(
  transaction transaction,
  object attributedefinition,
  optional object language,
  optional object attributedefinitionlist,
  optional integer flags)

string

GetAttributeStringEx2(
  transaction transaction,
  object attributedefinition,
  optional object language,
  optional object attributedefinitionlist,
  optional integer flags)

any

GetAttributeValue(
  transaction transaction,
  object attributedefinition,
  optional integer inx)

void

GetAttributeValue2(
  transaction transaction,
  object attributedefinition)

integer

GetAttributeValueCount(
  transaction transaction,
  object attributedefinition)

object

GetClass()

integer

GetCoostID()

integer

GetDomainMajorID()

integer

GetDomainMinorID()

integer

GetID()

string

GetIdentification(
  optional  reserved)

method

GetMethod(
  transaction transaction,
  object action)

string

GetName(
  optional transaction transaction)

integer

GetObjID()

string

GetReference(
  optional  reserved)

string

GetShortReference(
  optional  reserved)

string

GetSimpleReference(
  optional  reserved)

datetime

GetVersDate()

integer

GetVersNr()

boolean

HasAttribute(
  transaction transaction,
  object attributedefinition)

boolean

HasAttributeValue(
  transaction transaction,
  object attributedefinition,
  optional integer inx)

boolean

HasClass(
  object objectclass...)

boolean

IsClass(
  object objectclass...)

boolean

IsUsable(
  optional object objectclass...)

void

LoadAllAttributes(
  transaction transaction)

void

LoadClassAttributes(
  transaction transaction,
  object objectclass)

void

LoadSpecificAttributes(
  transaction transaction,
  object attributedefinitionlist)

void

Lock(
  transaction transaction,
  optional boolean recursive,
  optional boolean automaticunlock,
  optional integer timeout,
  optional boolean manualrefresh)

void

Reset()

void

SetAttribute(
  transaction transaction,
  object attributedefinition,
  optional any[] valuelist)

void

SetAttributeValue(
  transaction transaction,
  object attributedefinition,
  optional integer inx,
  optional any value)

Methods Permanent link for this heading


CallAction Permanent link for this heading

Calls the specified action with all supplied action parameters.

void CallAction(
  transaction transaction,
  object action,
  any[] parameterlist)

Name

Description

transaction

action

parameterlist


CallEmbeddedAction Permanent link for this heading

Calls the specified action in the context of another method.

void CallEmbeddedAction(
  transaction transaction,
  object action,
  optional method method)

Name

Description

transaction

action

method


CallMethod Permanent link for this heading

Calls the specified method.

void CallMethod(
  transaction transaction,
  method method)

Name

Description

transaction

method


CheckAccess Permanent link for this heading

Checks an access type for the object.

boolean CheckAccess(
  transaction transaction,
  object accesstype,
  optional boolean showerror)

Name

Description

transaction

accesstype

showerror

Show an error instead of setting the return value.

CheckAccessEx Permanent link for this heading

Checks an access type for the object with a certain user/domain/role.

boolean CheckAccessEx(
  transaction transaction,
  object accesstype,
  object user,
  optional object rolegroup,
  optional object roleposition,
  optional object clientdomain,
  optional object secclearance)

Name

Description

transaction

accesstype

user

rolegroup

roleposition

clientdomain

secclearance


CheckAggregateSetAccess Permanent link for this heading

Checks set access for a single line of an aggregate of the object.

boolean CheckAggregateSetAccess(
  transaction transaction,
  object attributedefinition,
  aggregate aggregate,
  optional boolean showerror)

Name

Description

transaction

attributedefinition

aggregate

showerror

Fail on invalid input

CheckGetAccess Permanent link for this heading

Checks get access for an attribute of the object.

boolean CheckGetAccess(
  transaction transaction,
  optional object attributedefinition,
  optional boolean showerror)

Name

Description

transaction

attributedefinition

The attribute definition which should be checked.

showerror

Show an error instead of setting the return value.

CheckGetSecured Permanent link for this heading

Checks secured get access for an attribute of the object.

boolean CheckGetSecured(
  object attributedefinition,
  optional boolean showerror)

Name

Description

attributedefinition

The attribute definition which should be checked.

showerror

Show an error instead of setting the return value.

CheckSetAccess Permanent link for this heading

Checks set access for an attribute of the object.

boolean CheckSetAccess(
  transaction transaction,
  optional object attributedefinition,
  optional boolean showerror)

Name

Description

transaction

attributedefinition

The attribute definition which should be checked.

showerror

Show an error instead of setting the return value.

CheckSetSecured Permanent link for this heading

Checks secured set access for an attribute of the object.

boolean CheckSetSecured(
  object attributedefinition,
  optional boolean showerror)

Name

Description

attributedefinition

The attribute definition which should be checked.

showerror

Show an error instead of setting the return value.

Compare Permanent link for this heading

Compares an object with another object.

boolean Compare(
  object object)

Name

Description

object


Delete Permanent link for this heading

Destroys the object.

void Delete(
  transaction transaction)

Name

Description

transaction


GetAddress Permanent link for this heading

Retrieves the address of the object.

string GetAddress(
  optional  reserved)

Name

Description

reserved


GetAttribute Permanent link for this heading

Retrieves all values of the attribute.

any[] GetAttribute(
  transaction transaction,
  object attributedefinition)

Name

Description

transaction

attributedefinition


GetAttribute3 Permanent link for this heading

Retrieves all values of the attribute.

void GetAttribute3(
  transaction transaction,
  object attributedefinition)

Name

Description

transaction

attributedefinition


GetAttributeString Permanent link for this heading

Retrieves the value of the attribute as string.

string GetAttributeString(
  transaction transaction,
  object attributedefinition,
  optional object language)

Name

Description

transaction

attributedefinition

language


GetAttributeStringEx Permanent link for this heading

Retrieves the value of the attribute as string.

string GetAttributeStringEx(
  transaction transaction,
  object attributedefinition,
  optional object language,
  optional object attributedefinitionlist,
  optional integer flags)

Name

Description

transaction

attributedefinition

language

attributedefinitionlist

flags


GetAttributeStringEx2 Permanent link for this heading

Retrieves the value of the attribute as string.

string GetAttributeStringEx2(
  transaction transaction,
  object attributedefinition,
  optional object language,
  optional object attributedefinitionlist,
  optional integer flags)

Name

Description

transaction

attributedefinition

language

attributedefinitionlist

flags


GetAttributeValue Permanent link for this heading

Retrieves a specific value of the attribute.

any GetAttributeValue(
  transaction transaction,
  object attributedefinition,
  optional integer inx)

Name

Description

transaction

attributedefinition

inx


GetAttributeValue2 Permanent link for this heading

Retrieves a specific value of the attribute.

void GetAttributeValue2(
  transaction transaction,
  object attributedefinition)

Name

Description

transaction

attributedefinition


GetAttributeValueCount Permanent link for this heading

Retrieves the number of values of the attribute.

integer GetAttributeValueCount(
  transaction transaction,
  object attributedefinition)

Name

Description

transaction

attributedefinition


GetClass Permanent link for this heading

Retrieves the object class of the object.

object GetClass()


GetCoostID Permanent link for this heading

Retrieves the coo store id of the object.

integer GetCoostID()


GetDomainMajorID Permanent link for this heading

Retrieves the domain major id of the object.

integer GetDomainMajorID()


GetDomainMinorID Permanent link for this heading

Retrieves the domain minor id of the object.

integer GetDomainMinorID()


GetID Permanent link for this heading

Retrieves the id of the object.

integer GetID()


GetIdentification Permanent link for this heading

Retrieves the identification of the object.

string GetIdentification(
  optional  reserved)

Name

Description

reserved


GetMethod Permanent link for this heading

Retrieves the specified method.

method GetMethod(
  transaction transaction,
  object action)

Name

Description

transaction

action


GetName Permanent link for this heading

Retrieves the name of the object.

string GetName(
  optional transaction transaction)

Name

Description

transaction


GetObjID Permanent link for this heading

Retrieves the object id of the object.

integer GetObjID()


GetReference Permanent link for this heading

Retrieves the reference of the object.

string GetReference(
  optional  reserved)

Name

Description

reserved


GetShortReference Permanent link for this heading

Retrieves the short reference of the object, which means that the component part is omitted for system objects.

string GetShortReference(
  optional  reserved)

Name

Description

reserved


GetSimpleReference Permanent link for this heading

Retrieves the simple reference of the object, which means that all separators are replaced by an underscore and that the component part is omitted for system objects.

string GetSimpleReference(
  optional  reserved)

Name

Description

reserved


GetVersDate Permanent link for this heading

Retrieves the version date and time of the object.

datetime GetVersDate()


GetVersNr Permanent link for this heading

Retrieves the version number of the object.

integer GetVersNr()


HasAttribute Permanent link for this heading

Tests whether the attribute is defined.

boolean HasAttribute(
  transaction transaction,
  object attributedefinition)

Name

Description

transaction

attributedefinition


HasAttributeValue Permanent link for this heading

Tests whether the attribute has a specific value.

boolean HasAttributeValue(
  transaction transaction,
  object attributedefinition,
  optional integer inx)

Name

Description

transaction

attributedefinition

inx


HasClass Permanent link for this heading

Returns true if the object is an instance of one of the passed object classes.

boolean HasClass(
  object objectclass...)

Name

Description

objectclass...


IsClass Permanent link for this heading

Returns true if the object is one of the passed object classes or derived from at leaset one of the passed object classes.

boolean IsClass(
  object objectclass...)

Name

Description

objectclass...


IsUsable Permanent link for this heading

Checks whether the object is usable, i.e. the object is an instance of one of the passed object classes, is not deleted, and the current user has at least read access to the object.
If no object class is passed as a parameter, the object class Object is used as default.
This function can be used to optimize terms like
obj.HasClass(#Object) && !cootx.IsDeleted(obj) && CheckAccess(cootx, #AccTypeRead) && !obj.objdeleted

boolean IsUsable(
  optional object objectclass...)

Name

Description

objectclass...


LoadAllAttributes Permanent link for this heading

Loads all attributes for the object.

void LoadAllAttributes(
  transaction transaction)

Name

Description

transaction


LoadClassAttributes Permanent link for this heading

Loads class attributes for the object.

void LoadClassAttributes(
  transaction transaction,
  object objectclass)

Name

Description

transaction

objectclass


LoadSpecificAttributes Permanent link for this heading

Loads specific attributes for the object.

void LoadSpecificAttributes(
  transaction transaction,
  object attributedefinitionlist)

Name

Description

transaction

attributedefinitionlist


Lock Permanent link for this heading

Locks the object.

void Lock(
  transaction transaction,
  optional boolean recursive,
  optional boolean automaticunlock,
  optional integer timeout,
  optional boolean manualrefresh)

Name

Description

transaction

recursive

automaticunlock

timeout

manualrefresh


Reset Permanent link for this heading

Removes object from the cache.

void Reset()


SetAttribute Permanent link for this heading

Sets all values of the attribute.

void SetAttribute(
  transaction transaction,
  object attributedefinition,
  optional any[] valuelist)

Name

Description

transaction

attributedefinition

valuelist


SetAttributeValue Permanent link for this heading

Sets a specific value of the attribute.

void SetAttributeValue(
  transaction transaction,
  object attributedefinition,
  optional integer inx,
  optional any value)

Name

Description

transaction

attributedefinition

inx

value