TIBCO EBX®
Rules Portfolio Add-on Documentation > Scripting Language
Navigation modeRules Portfolio Add-on Documentation > Scripting Language

Appendix

List of all predefined objects

Object

Method

Description

record

An object bean representing the current record.

getPrimaryKey()

Returns the record's formatted primary key.

save()

This method commits any changes to the current record. Keep in mind only an 'Automated rule' and a 'Table set rule' can modify data. If you call this method with any other type of rule, or have insufficient permissions, it does nothing.

You can call this method using 'save()' and 'save(isTriggerActive)'. In the first example, the parameter is not specified and triggers are enabled. However, in the second example, the trigger depends on the 'isTriggerActive' boolean value. Setting the input value to 'true' activates the trigger. Otherwise, the trigger is inactive.

del()

This method deletes the current record. Keep in mind only an 'Automated rule' and a 'Table set rule' can modify data. If you call this method with any other type of rule, or have insufficient permissions, it does nothing.

query

Queries the current table's data.

getQuery(String tablePath)

Returns the query object for the specified table using tablePath.

getQuery(String datasetName, String tablePath)

Returns the query object for a table from a specific data set in the current data space.

getQuery(String homeKey, boolean isBranch, String datasetName, String tablePath)

Returns the query object for a table from a specific data set and data space (isBranch = true) or snapshot (isBranch = false).

newRecord()

Returns the object bean for the new record on the current table.

records(xPathPredicate)

Returns a list of object beans based on the specified xPathPredicate.

log

Writes information to the log file.

error(message)

Writes a message to the log file with the severity level of ERROR.

info(message)

Writes a message to the log file with the severity level of INFO.

debug(message)

Writes a message to the log file with the severity level of DEBUG.

warn(message)

Writes a message to the log file with the severity level of WARNING.

validation

Sets the validation message.

error()

Sets to error.

error(message)

Sets to error with message.

info()

Sets to info.

info(message)

Sets to info with message.

warning()

Sets to warning.

warning(message)

Sets to warning with message.

setMessage(message)

Sets the message.

getMessage()

Returns the message.

hasInfo()

Returns true if it has info.

hasError()

Returns true if it has error.

hasWarning()

Returns true if it has warning.

dataset

Gets information about the current data set.

getDataModel()

Returns the formatted schema location of the current data set.

getModuleName()

Returns the module name of the current data set.

getOwner()

Returns the owner of the current data set.

getUniqueName()

Returns the adaptation name of the current data set.

node

Gets information about the current node.

getPath()

Returns the path in the schema of node.

getCategory()

Returns the current node's category.

getDataType()

Returns the current node's data type.

isAssociationNode()

Returns true if the current node is an association node.

isAutoIncrement()

Returns true if the current node is an auto increment.

isComplex()

Returns true if the current node is a complex node.

isHistoryDisabled()

Returns true if history is disabled on this node.

isSelectNode()

Returns true if the current node is a selection node.

isTableNode()

Returns true if the current node is a table node.

isTableOccurrenceNode()

Returns true if the current node is a table occurrence node.

isTerminalValue()

Returns true if the current node is a terminal node.

isTerminalValueComputed()

Returns true if the current node is a terminal computed node.

isTerminalValueDescendant()

Returns true if the current node is a terminal descendant node.

isValueFunction()

Returns true if the current node is a value function node.

session

Gets information for the current session.

getUserID()

Returns the current user id.

getAttribute(String name)

Returns the attribute value by name.

isUserInRole(String roleName)

Returns true if the current user is in the specified role. The roleName must start with prefix 'R'

This method is deprecated. Use the isUserInSpecificRole(String roleName) method instead.

isUserInSpecificRole(String roleName)

Returns true if the current user is in the specified role.

isUserInAdminRole()

Returns true if the current user is in the admin role.

isUserInReadOnlyRole()

Returns true if the current user is in the read-only role.

HIDDEN

Represents the hidden permission for both Access and Action permission.

READONLY

Represents the read-only access permission.

READWRITE

Represents the read-write access permission.

DISABLE

Represents the disable action permission.

ENABLE

Represents the enable action permission.