Interface CooObject

This interface describes methods available when working with objects.

Methods

Return Type	Signature
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)
boolean	ContainsAttributeValue( transaction transaction, object attributedefinition, any value)
string	GetAddress( optional reserved)
object	GetAspect( optional transaction transaction)
any[]	GetAttribute( 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)
any	GetAttributeValue( transaction transaction, object attributedefinition, optional integer inx)
integer	GetAttributeValueCount( transaction transaction, object attributedefinition)
object	GetClass( optional transaction transaction)
integer	GetCoostID()
integer	GetDomainMajorID()
integer	GetDomainMinorID()
integer	GetID()
string	GetIdentification( optional reserved)
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	HasClassEx( transaction transaction, object objectclass...)
boolean	IsClass( object objectclass...)
boolean	IsUsable( optional object objectclass...)
void	LoadAllAttributes( transaction transaction)
void	LoadSpecificAttributes( transaction transaction, object[] attributedefinitionlist)

Methods

CheckAccess

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

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

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

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

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

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

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

Returns true if this object has the same identity as the passed object.
Note: This method does not compare the object properties.

boolean Compare(
object object)

Name	Description
object

ContainsAttributeValue

Tests whether the attribute contains a specific value.

boolean ContainsAttributeValue(
  transaction transaction,
  object attributedefinition,
  any value)

Name	Description
transaction	The transaction to be used (e.g. `cootx` for the current one). Might be `null` for checking directly without transaction.
attributedefinition	The definition of the attribute on the object to be checked for values.
value	Only scalar values of type boolean, datetime, enum, float, integer, object and string are supported.

GetAddress

Retrieves the address of the object.

string GetAddress(
optional reserved)

Name	Description
reserved

GetAspect

Retrieves the object aspect of the object.

object GetAspect(
optional transaction transaction)

Name	Description
transaction	The transaction to be used. If no transaction is supplied, the current transaction is used.

GetAttribute

Retrieves all values of the attribute.

any[] GetAttribute(
transaction transaction,
object attributedefinition)

Name	Description
transaction
attributedefinition

GetAttributeString

Retrieves the value of the attribute as string.

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

Name	Description
transaction
attributedefinition
language

GetAttributeStringEx

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	Possible flags: COODISP_NORMAL, COODISP_OBJADDRESS, COODISP_OBJREFERENCE, COODISP_ENUMREFERENCE, COODISP_XML, COODISP_HTML, COODISP_ROWLIST, COODISP_COLUMNLIST, COODISP_NOLISTINDICATOR

GetAttributeValue

Retrieves a specific value of the attribute.

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

Name	Description
transaction
attributedefinition
inx

GetAttributeValueCount

Retrieves the number of values of the attribute.

integer GetAttributeValueCount(
transaction transaction,
object attributedefinition)

Name	Description
transaction
attributedefinition

GetClass

Retrieves the object class of the object.

object GetClass(
optional transaction transaction)

Name	Description
transaction	The transaction to be used. If no transaction is supplied, the current transaction is used.

GetCoostID

Retrieves the coo store id of the object.

integer GetCoostID()

GetDomainMajorID

Retrieves the domain major id of the object.

integer GetDomainMajorID()

GetDomainMinorID

Retrieves the domain minor id of the object.

integer GetDomainMinorID()

GetID

Retrieves the id of the object.

integer GetID()

GetIdentification

Retrieves the identification of the object.

string GetIdentification(
optional reserved)

Name	Description
reserved

GetName

Retrieves the name of the object including status information (e.g. "archived", "canceled", "deleted", "obsolete", "replaced", etc.). In case of an error, the resulting string contains the error message instead of throwing an exception.

string GetName(
optional transaction transaction)

Name	Description
transaction	The transaction to be used. If no transaction is supplied, the current transaction is used.

GetObjID

Retrieves the object id of the object.

integer GetObjID()

GetReference

Retrieves the reference of the object.

string GetReference(
optional reserved)

Name	Description
reserved

GetShortReference

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

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

Retrieves the version date and time of the object.

datetime GetVersDate()

GetVersNr

Retrieves the version number of the object.

integer GetVersNr()

HasAttribute

Tests whether the attribute is defined.

boolean HasAttribute(
transaction transaction,
object attributedefinition)

Name	Description
transaction
attributedefinition

HasAttributeValue

Tests whether the attribute has a value.

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

Name	Description
transaction
attributedefinition
inx

HasClass

Returns true if the object is an instance of one of the passed object classes. The current transaction is used for retrieving the object class/aspect.

boolean HasClass(
object objectclass...)

Name	Description
objectclass...

HasClassEx

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

boolean HasClassEx(
transaction transaction,
object objectclass...)

Name	Description
transaction	The transaction to be used.
objectclass...

IsClass

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

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 the object is temporarily unavailable (e.g. the object's service is temporarily unavailable), the function returns false without an error. Accordingly, the result should not be persisted without further checks (e.g. whether the object class can be read).
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

Loads all attributes for the object.

void LoadAllAttributes(
transaction transaction)

Name	Description
transaction

LoadSpecificAttributes

Loads specific attributes for the object.

void LoadSpecificAttributes(
transaction transaction,
object[] attributedefinitionlist)

Name	Description
transaction
attributedefinitionlist