Interface CooAggregate

This interface describes methods available when working with structs.

Methods

Return Type	Signature
boolean	Compare( aggregate aggregate)
aggregate	Copy()
any[]	GetAttribute( 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( object attributedefinition, optional integer inx)
integer	GetAttributeValueCount( object attributedefinition)
object	GetTypeDefinition()
boolean	HasAttribute( object attributedefinition)
boolean	HasAttributeValue( object attributedefinition, optional integer inx)
boolean	IsModified()
void	SetAttribute( object attributedefinition, optional any[] valuelist)
void	SetAttributeValue( object attributedefinition, optional integer inx, optional any value)
void	Split()

Methods

Compare

Returns true if this agggreate has the same identity as the passed aggegate.
Note: This method does not compare the aggregate values.

boolean Compare(
aggregate aggregate)

Name	Description
aggregate

Copy

Copies an aggregate.

aggregate Copy()

GetAttribute

Retrieves all values of the attribute.

any[] GetAttribute(
object attributedefinition)

Name	Description
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(
object attributedefinition,
optional integer inx)

Name	Description
attributedefinition
inx

GetAttributeValueCount

Retrieves the number of values of the attribute.

integer GetAttributeValueCount(
object attributedefinition)

Name	Description
attributedefinition

GetTypeDefinition

Retrieves the type definition of the aggregate.

object GetTypeDefinition()

HasAttribute

Tests whether the attribute is defined.

boolean HasAttribute(
object attributedefinition)

Name	Description
attributedefinition

HasAttributeValue

Tests whether the attribute has a value.

boolean HasAttributeValue(
object attributedefinition,
optional integer inx)

Name	Description
attributedefinition
inx

IsModified

Tests whether the aggregate contains modifications.

boolean IsModified()

SetAttribute

Sets all values of the attribute.

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

Name	Description
attributedefinition
valuelist

SetAttributeValue

Sets a specific value of the attribute.

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

Name	Description
attributedefinition
inx
value

Split

Disables copy-on-write for this instance and existing/new attribute values by copying them if other references exist.
By default, an instance is copied whenever it is modified and other references exist so that those references remain unaffected and still refer to an unmodified instance. By splitting the instance, references created after the split operation keep referring to this instance even if it is modified. Consequently, splitting an instance is desirable if instance modifications should be visible to other references (instance sharing).

In expressions, all variables are split by default because expression scopes based on dictionaries or aggregates are guaranteed to be split. Therefore, this method is more relevant for other programming languages that do not perform auto-splitting.

void Split()