Interface CooRuntime

This interface describes methods available when working with runtimes.

Methods

Return Type	Signature
boolean	CheckObjects( transaction transaction, string query, optional dictionary queryarguments)
void	CheckProductLicense( transaction transaction, string reference)
boolean	CompareAggregates( aggregate aggregate1, aggregate aggregate2)
boolean	CompareAggregatesEx( aggregate aggregate1, aggregate aggregate2, optional object[] attributedefinitionlist)
boolean	CompareContents( content content1, content content2)
boolean	CompareDictionaries( dictionary dictionary1, dictionary dictionary2)
boolean	CompareObjects( object object1, object object2)
integer	CompareValues( transaction transaction, any value1, any value2, optional boolean checkexistance, optional boolean ignorecase, optional boolean numericvalues, optional boolean showerror)
object	GetAttributeDefinition( string reference)
object	GetBaseObjectClass( object objectclass)
object	GetComponentObject( object objectclass, string reference)
datetime	GetCurrentDateTime( object object)
object	GetCurrentDomain()
object	GetCurrentUser()
object	GetCurrentUserEnvironment()
object	GetCurrentUserHome()
object	GetCurrentUserLanguage()
object	GetCurrentUserLocale()
string	GetCurrentUserRoleFunction( optional reserved)
object	GetCurrentUserRoleGroup()
object	GetCurrentUserRolePosition()
object	GetCurrentUserRoleSubstUser()
object	GetCurrentUserRoot()
object	GetCurrentWorkStation()
object[]	GetDerivedObjectClasses( object objectclass)
object[]	GetDirectDerivedObjectClasses( object objectclass)
object	GetErrorAction( integer result)
string	GetErrorCallStack( integer result)
integer	GetErrorColumn( integer result)
object	GetErrorContext( integer result)
integer	GetErrorLine( integer result)
object	GetErrorMessage( integer result)
object	GetErrorObject( integer result)
string	GetErrorSection( integer result)
string	GetErrorStatement( integer result)
string	GetErrorText( integer result)
integer	GetKernelFlags()
object	GetLanguage( string reference)
object	GetObject( string address, optional boolean showerror)
object	GetObjectClass( string reference, optional boolean showerror)
object	GetObjectEx( integer domainmajorid, integer domainminorid, integer coostid, integer objid)
object[]	GetObjects( transaction transaction, string[] addresslist, optional boolean showerror)
object	GetPrimaryDomain()
object	GetSoftwareComponent( string reference, optional boolean showerror)
object	GetSoftwareProduct( string reference, optional boolean showerrors)
object	GetThreadAction( optional integer inx)
method	GetThreadCallCount( optional integer inx)
method	GetThreadCallStack( optional integer inx)
integer	GetThreadColumn( integer inx)
object	GetThreadContext( optional integer inx)
integer	GetThreadFlags()
integer	GetThreadLine( optional integer inx)
method	GetThreadMethod( optional integer inx)
object	GetThreadObject( optional integer inx)
string	GetThreadSection( optional integer inx)
string	GetThreadStatement( optional integer inx)
integer	GetThreadTimeZoneBias()
transaction	GetThreadTransaction()
object	GetTypeDefinition( string reference, optional boolean showerror)
integer	GetVersion()
boolean	IsDebug()
boolean	IsError( integer result)
boolean	IsInteractive()
boolean	IsVisible()
void	LoadAllAttributes( transaction transaction, object[] objectlist, integer flags)
void	LoadAllAttributesEx( transaction transaction, object[] objectlist, object[] valueattributedefinitionlist, integer flags)
void	LoadSpecificAttributes( transaction transaction, object[] objectlist, object[] attributedefinitionlist, integer flags)
void	LoadSpecificAttributesEx( transaction transaction, object[] objectlist, object[] attributedefinitionlist, object[] valueattributedefinitionlist, integer flags)
void	Log( integer level, string message)
string	NumberAbs( string x)
string	NumberAdd( string x, string y)
string	NumberChs( string x)
integer	NumberCompare( string x, string y)
string	NumberDiv( string x, string y)
string	NumberMul( string x, string y)
string	NumberPow( string x, integer exponent)
string	NumberRound( string x, integer fractions)
string	NumberSub( string x, string y)
string	NumberTrunc( string x, integer fractions)
void	ReportEventEx( string source, string sourceid, integer id, string message, optional integer type, optional integer category)
object[]	SearchLocalObjects( transaction transaction, object objectclass)
searchresult	SearchLocalObjectsAsync( transaction transaction, object objectclass)
object[]	SearchObjects( transaction transaction, string query, optional dictionary queryarguments)
searchresult	SearchObjectsAsync( transaction transaction, string query, optional dictionary queryarguments)
any	SearchValues( transaction transaction, string query, optional dictionary queryarguments)
integer	SetError( object errormessage, optional string errortext)
any	SortValues( transaction transaction, any values, optional boolean sort, optional boolean unique, optional boolean revert, optional boolean ignorecase, optional boolean numericvalues, optional boolean showerror)
void	Trace( string text, optional any[] valuelist)

Methods

CheckObjects

Checks if objects exist.

boolean CheckObjects(
  transaction transaction,
  string query,
  optional dictionary queryarguments)

Name	Description
transaction
query	The query (see Query Language for details).
queryarguments	Key value pairs which can be referenced within the query using `$key`.

CheckProductLicense

Checks the license of a software product.

void CheckProductLicense(
transaction transaction,
string reference)

Name	Description
transaction
reference

CompareAggregates

Compares two aggregates. See CooAggregate.Compare for additional information.

boolean CompareAggregates(
aggregate aggregate1,
aggregate aggregate2)

Name	Description
aggregate1
aggregate2

CompareAggregatesEx

Compares two aggregates using certain attributes.

boolean CompareAggregatesEx(
  aggregate aggregate1,
  aggregate aggregate2,
  optional object[] attributedefinitionlist)

Name	Description
aggregate1
aggregate2
attributedefinitionlist

CompareContents

Compares two contents. See CooContent.Compare for additional information.

boolean CompareContents(
content content1,
content content2)

Name	Description
content1
content2

CompareDictionaries

Compares two dictionaries. See CooDictionary.Compare for additional information.

boolean CompareDictionaries(
dictionary dictionary1,
dictionary dictionary2)

Name	Description
dictionary1
dictionary2

CompareObjects

Compares two objects. See CooObject.Compare for additional information.

boolean CompareObjects(
object object1,
object object2)

Name	Description
object1
object2

CompareValues

Compares two values.

integer CompareValues(
  transaction transaction,
  any value1,
  any value2,
  optional boolean checkexistance,
  optional boolean ignorecase,
  optional boolean numericvalues,
  optional boolean showerror)

Name	Description
transaction
value1
value2
checkexistance
ignorecase
numericvalues
showerror

GetAttributeDefinition

Retrieves an attribute definition.

object GetAttributeDefinition(
string reference)

Name	Description
reference

GetBaseObjectClass

Retrieves the object class an object class is derived from.

object GetBaseObjectClass(
object objectclass)

Name	Description
objectclass

GetComponentObject

Retrieves a component object.

object GetComponentObject(
object objectclass,
string reference)

Name	Description
objectclass
reference

GetCurrentDateTime

Retrieves the current date and time from the machine where the object is stored.

datetime GetCurrentDateTime(
object object)

Name	Description
object

GetCurrentDomain

Retrieves the current domain.

object GetCurrentDomain()

GetCurrentUser

Retrieves the current user.

object GetCurrentUser()

GetCurrentUserEnvironment

Retrieves the current environment of the current user.

object GetCurrentUserEnvironment()

GetCurrentUserHome

Retrieves the home object of the current user.

object GetCurrentUserHome()

GetCurrentUserLanguage

Retrieves the current language.

object GetCurrentUserLanguage()

GetCurrentUserLocale

Retrieves the current locale or the current language if no locale is set.

object GetCurrentUserLocale()

GetCurrentUserRoleFunction

Retrieves the function of the current role of the current user.

string GetCurrentUserRoleFunction(
optional reserved)

Name	Description
reserved

GetCurrentUserRoleGroup

Retrieves the group of the current role of the current user.

object GetCurrentUserRoleGroup()

GetCurrentUserRolePosition

Retrieves the position of the current role of the current user.

object GetCurrentUserRolePosition()

GetCurrentUserRoleSubstUser

Retrieves the substitution user of the current role of the current user.

object GetCurrentUserRoleSubstUser()

GetCurrentUserRoot

Retrieves the root object of the current user.

object GetCurrentUserRoot()

GetCurrentWorkStation

Retrieves the current workstation.

object GetCurrentWorkStation()

GetDerivedObjectClasses

Retrieves all object classes derived from an object class.

object[] GetDerivedObjectClasses(
object objectclass)

Name	Description
objectclass

GetDirectDerivedObjectClasses

Retrieves all object classes directly derived from an object class.

object[] GetDirectDerivedObjectClasses(
object objectclass)

Name	Description
objectclass

GetErrorAction

Retrieves the action from an error number.

object GetErrorAction(
integer result)

Name	Description
result

GetErrorCallStack

Retrieves the method call stack from an error number.

string GetErrorCallStack(
integer result)

Name	Description
result

GetErrorColumn

Retrieves the error column of an expression from an error number.

integer GetErrorColumn(
integer result)

Name	Description
result

GetErrorContext

Retrieves the contect from an error number.

object GetErrorContext(
integer result)

Name	Description
result

GetErrorLine

Retrieves the error line of an expression from an error number.

integer GetErrorLine(
integer result)

Name	Description
result

GetErrorMessage

Retrieves the error message object from an error number.

object GetErrorMessage(
integer result)

Name	Description
result

GetErrorObject

Retrieves the object from an error number.

object GetErrorObject(
integer result)

Name	Description
result

GetErrorSection

Retrieves the error section of an expression from an error number.

string GetErrorSection(
integer result)

Name	Description
result

GetErrorStatement

Retrieves the error statement of an expression from an error number.

string GetErrorStatement(
integer result)

Name	Description
result

GetErrorText

Retrieves the error text from an error number.

string GetErrorText(
integer result)

Name	Description
result

GetKernelFlags

Retrieves the global kernel flags.

integer GetKernelFlags()

GetLanguage

Retrieves a language.

object GetLanguage(
string reference)

Name	Description
reference

GetObject

Retrieves the object for an address.

object GetObject(
string address,
optional boolean showerror)

Name	Description
address
showerror	Fail on invalid input

GetObjectClass

Retrieves an object class.

object GetObjectClass(
string reference,
optional boolean showerror)

Name	Description
reference
showerror	Fail on invalid input

GetObjectEx

Retrieves the object for an address.

object GetObjectEx(
  integer domainmajorid,
  integer domainminorid,
  integer coostid,
  integer objid)

Name	Description
domainmajorid
domainminorid
coostid
objid

GetObjects

Retrieves objects for an list of addresses.

object[] GetObjects(
  transaction transaction,
  string[] addresslist,
  optional boolean showerror)

Name	Description
transaction
addresslist
showerror	Fail on invalid input

GetPrimaryDomain

Retrieves the primary domain.

object GetPrimaryDomain()

GetSoftwareComponent

Retrieves a software component.

object GetSoftwareComponent(
string reference,
optional boolean showerror)

Name	Description
reference
showerror	Fail on invalid input

GetSoftwareProduct

Retrieves a software product.

object GetSoftwareProduct(
string reference,
optional boolean showerrors)

Name	Description
reference
showerrors	Fail on invalid input

GetThreadAction

Retrieves the action of the current thread.

object GetThreadAction(
optional integer inx)

Name	Description
inx

GetThreadCallCount

Retrieves the method call count of the current thread.

method GetThreadCallCount(
optional integer inx)

Name	Description
inx

GetThreadCallStack

Retrieves the method of the current thread.

method GetThreadCallStack(
optional integer inx)

Name	Description
inx

GetThreadColumn

Retrieves the line position of the expression execution of the current thread.

integer GetThreadColumn(
integer inx)

Name	Description
inx

GetThreadContext

Retrieves the context of the current thread.

object GetThreadContext(
optional integer inx)

Name	Description
inx

GetThreadFlags

Retrieves the flags of the current thread.

integer GetThreadFlags()

GetThreadLine

Retrieves the line of an expression of the current thread.

integer GetThreadLine(
optional integer inx)

Name	Description
inx

GetThreadMethod

Retrieves the method call stack of the current thread.

method GetThreadMethod(
optional integer inx)

Name	Description
inx

GetThreadObject

Retrieves the object of the current thread.

object GetThreadObject(
optional integer inx)

Name	Description
inx

GetThreadSection

Retrieves the section of an expression of the current thread.

string GetThreadSection(
optional integer inx)

Name	Description
inx

GetThreadStatement

Retrieves the statement of an expression of the current thread.

string GetThreadStatement(
optional integer inx)

Name	Description
inx

GetThreadTimeZoneBias

Retrieves the time zone bias to UTC of the current thread.

integer GetThreadTimeZoneBias()

GetThreadTransaction

Retrieves the transaction of the current thread.

transaction GetThreadTransaction()

GetTypeDefinition

Retrieves a type definition.

object GetTypeDefinition(
string reference,
optional boolean showerror)

Name	Description
reference
showerror	Fail on invalid input

GetVersion

Retrieves the current kernel version.

integer GetVersion()

IsDebug

Checks whether the kernel is a debug kernel.

boolean IsDebug()

IsError

Checks an error number.

boolean IsError(
integer result)

Name	Description
result

IsInteractive

Checks whether the kernel executes under an interactive environment.

boolean IsInteractive()

IsVisible

Checks whether the kernel executes under a visible environment.

boolean IsVisible()

LoadAllAttributes

Loads all attributes for the specified objects.

void LoadAllAttributes(
  transaction transaction,
  object[] objectlist,
  integer flags)

Name	Description
transaction
objectlist
flags	Possible flags: COOLF_NORMAL, COOLF_NOSECATTRIBUTES, COOLF_DONTFOLLOW, COOLF_EXCLUDEATTRIBUTES

LoadAllAttributesEx

Loads all attributes for the specified objects and specific attributs of the values.

void LoadAllAttributesEx(
  transaction transaction,
  object[] objectlist,
  object[] valueattributedefinitionlist,
  integer flags)

Name	Description
transaction
objectlist
valueattributedefinitionlist
flags	Possible flags: COOLF_NORMAL, COOLF_NOSECATTRIBUTES, COOLF_DONTFOLLOW, COOLF_EXCLUDEATTRIBUTES

LoadSpecificAttributes

Loads specific attributes for the specified objects.

void LoadSpecificAttributes(
  transaction transaction,
  object[] objectlist,
  object[] attributedefinitionlist,
  integer flags)

Name	Description
transaction
objectlist
attributedefinitionlist
flags	Possible flags: COOLF_NORMAL, COOLF_NOSECATTRIBUTES, COOLF_DONTFOLLOW, COOLF_EXCLUDEATTRIBUTES

LoadSpecificAttributesEx

Loads specific attributes for the specified objects and specific attributs of the values.

void LoadSpecificAttributesEx(
  transaction transaction,
  object[] objectlist,
  object[] attributedefinitionlist,
  object[] valueattributedefinitionlist,
  integer flags)

Name	Description
transaction
objectlist
attributedefinitionlist
valueattributedefinitionlist
flags

Log

Logs a string in Fabasoft app.telemetry.

void Log(
integer level,
string message)

Name	Description
level	Possible flags: COOLL_LOG, COOLL_IPC, COOLL_NORMAL, COOLL_DETAIL, COOLL_DEBUG, COOLL_DEFAULT
message

NumberAbs

Computes the absolute value of a string.

string NumberAbs(
string x)

Name	Description
x

NumberAdd

Adds two strings.

string NumberAdd(
string x,
string y)

Name	Description
x
y

NumberChs

Changes the sign of a string.

string NumberChs(
string x)

Name	Description
x

NumberCompare

Compares two strings.

integer NumberCompare(
string x,
string y)

Name	Description
x
y

NumberDiv

Divides two strings.

string NumberDiv(
string x,
string y)

Name	Description
x
y

NumberMul

Multiplies two strings.

string NumberMul(
string x,
string y)

Name	Description
x
y

NumberPow

Multiplies the string with a power of 10.

string NumberPow(
string x,
integer exponent)

Name	Description
x
exponent

NumberRound

Rounds a string.

string NumberRound(
string x,
integer fractions)

Name	Description
x
fractions

NumberSub

Subtracts two strings.

string NumberSub(
string x,
string y)

Name	Description
x
y

NumberTrunc

Truncates a string.

string NumberTrunc(
string x,
integer fractions)

Name	Description
x
fractions

ReportEventEx

Reports an event with a unique id to the operating system.

void ReportEventEx(
  string source,
  string sourceid,
  integer id,
  string message,
  optional integer type,
  optional integer category)

Name	Description
source
sourceid
id
message
type	Possible flags: COORE_TYPE_ERROR, COORE_TYPE_WARNING, COORE_TYPE_INFORMATION, COORE_TYPE_SUCCESS
category	Possible flags: COORE_CATEGORY_NONE, COORE_CATEGORY_UNKNOWN, COORE_CATEGORY_INTERNAL, COORE_CATEGORY_TRACE, COORE_CATEGORY_MESSAGE, COORE_CATEGORY_APPLICATION, COORE_CATEGORY_INSTALLATION, COORE_CATEGORY_PERFORMANCE

SearchLocalObjects

Searches for cached objects of the specified class.

object[] SearchLocalObjects(
transaction transaction,
object objectclass)

Name	Description
transaction
objectclass

SearchLocalObjectsAsync

Searches for cached objects of the specified class.

searchresult SearchLocalObjectsAsync(
transaction transaction,
object objectclass)

Name	Description
transaction
objectclass

SearchObjects

Searches for objects.

object[] SearchObjects(
  transaction transaction,
  string query,
  optional dictionary queryarguments)

Name	Description
transaction
query	The query (see Query Language for details).
queryarguments	Key value pairs which can be referenced within the query using `$key`.

SearchObjectsAsync

Searches for objects.

searchresult SearchObjectsAsync(
  transaction transaction,
  string query,
  optional dictionary queryarguments)

Name	Description
transaction
query	The query (see Query Language for details).
queryarguments	Key value pairs which can be referenced within the query using `$key`.

SearchValues

Searches for values using aggregate functions COUNT, SUM, MIN or MAX.

any SearchValues(
  transaction transaction,
  string query,
  optional dictionary queryarguments)

Name	Description
transaction
query	The query (see Query Language for details).
queryarguments	Key value pairs which can be referenced within the query using `$key`.

SetError

Generates an error number from an error message object and an error text.

integer SetError(
object errormessage,
optional string errortext)

Name	Description
errormessage	The assigned error message object.
errortext	The actual text for the error. If omitted, the text of the error message object is used.

SortValues

Sort any list of values.

any SortValues(
  transaction transaction,
  any values,
  optional boolean sort,
  optional boolean unique,
  optional boolean revert,
  optional boolean ignorecase,
  optional boolean numericvalues,
  optional boolean showerror)

Name	Description
transaction
values
sort
unique
revert
ignorecase
numericvalues
showerror

Trace

Traces a string with an optional value list.

void Trace(
string text,
optional any[] valuelist)

Name	Description
text
valuelist