com.whitestein.lsps.stdlib.function

Interface ActionFunctions

All Known Implementing Classes:

ActionFunctionsImpl

public interface ActionFunctions

Functions that performs an action.

Author:

bhl

Method Summary

Modifier and Type	Method and Description
void	cleanEvaluation(ExecutionContext ctx) Cleans auxiliary contexts and values used by the evaluation in the 'isFullExecutionMode = false' mode.
RecordHolder	createInstance(ExecutionContext ctx, Type type, MapHolder values) Creates new instance of record type T.
RecordHolder	createModelInstance(ExecutionContext ctx, Boolean synchronous, RecordHolder model, MapHolder properties) Creates a model instance.
RecordHolder	createModelInstance(ExecutionContext ctx, Boolean synchronous, RecordHolder model, RecordHolder processEntity, MapHolder properties) Creates a model instance with a specified process entity record.
ListHolder	createProxy(ExecutionContext ctx, ListHolder list, Property... properties) Creates a list of record proxies.
RecordHolder	createProxy(ExecutionContext ctx, Object record, Property... properties) Creates a change proxy on the record that keeps all changes.
SetHolder	createProxy(ExecutionContext ctx, SetHolder set, Property... properties) Creates a set of record proxies.
RecordHolder	createProxy(ExecutionContext ctx, Type type) Creates a proxy without proxied record.
RecordHolder	createProxy(ExecutionContext ctx, Type type, Decimal proxyLevel) Creates a proxy without proxied record.
void	createProxyOfProperties(ExecutionContext ctx, RecordHolder record, Property... properties) Creates change proxy for all object referenced by the propery and sets the proxy values to the property.
String	debugLog(ExecutionContext ctx, ClosureHolder message) Logs a message to the console at the debug logging level.
String	debugLog(ExecutionContext ctx, ClosureHolder message, Decimal level) Logs a message to the console at the specified logging level.
void	deleteAllRecords(ExecutionContext ctx, CollectionHolder records) Deletes the specified records and all related data links navigable from the deleted records.
void	deleteRecords(ExecutionContext ctx, RecordHolder... records) Deletes the specified records and all related data links navigable from the deleted records.
Object	evaluateExpression(ExecutionContext ctx, Boolean isFullExecutionMode, ClosureHolder expression) This method evaluates an expression defined in the closure using defined evaluationMode.
Decimal	getProxyLevel(ExecutionContext ctx, RecordHolder record) Returns proxy level of the record.
void	log(ExecutionContext ctx, String message, Decimal level) Logs a message to the application log on specified level.
ListHolder	mergeAllProxies(ExecutionContext ctx, Boolean checkConflicts, CollectionHolder records) Merges changes from the proxies to the proxied records.
ListHolder	mergeAllProxies(ExecutionContext ctx, CollectionHolder records) Merges changes from the proxies to the proxied records.
ListHolder	mergeAllProxiesDeep(ExecutionContext ctx, Boolean checkConflicts, CollectionHolder records) Merges changes from the proxies to the proxied records.
ListHolder	mergeAllProxiesDeep(ExecutionContext ctx, CollectionHolder records) Merges changes from the proxies to the proxied records.
void	mergeEvaluation(ExecutionContext ctx) Merges auxiliary contexts and values to the original execution contexts and values.
ListHolder	mergeProxies(ExecutionContext ctx, Boolean checkConflicts, Object... records) Merges changes from the proxies to the proxied records.
ListHolder	mergeProxies(ExecutionContext ctx, Object... records) Merges changes from the proxies to the proxied records.
ListHolder	mergeProxiesDeep(ExecutionContext ctx, Boolean checkConflicts, Object... records) Merges changes from the proxies to the proxied records.
ListHolder	mergeProxiesDeep(ExecutionContext ctx, Object... records) Merges changes from the proxies to the proxied records.
void	notifyModelInstance(ExecutionContext ctx, Decimal modelInstanceId, String reason, Boolean synchronously) Notify provided model instance.
void	sendSignal(ExecutionContext ctx, Boolean sychronous, SetHolder receivers, Object signal) Sends a sync or async signal to receivers.
void	throwEscalation(ExecutionContext ctx, String escalationCode, Object payload) Throws an escalation event with the escalation code and optional payload.

Method Detail

sendSignal

void sendSignal(ExecutionContext ctx,
                Boolean sychronous,
                SetHolder receivers,
                Object signal)
         throws ErrorException

Sends a sync or async signal to receivers.

Parameters:

ctx -

sychronous -

receivers -

signal -

Throws:

ErrorException

createModelInstance

RecordHolder createModelInstance(ExecutionContext ctx,
                                 Boolean synchronous,
                                 RecordHolder model,
                                 MapHolder properties)
                          throws ErrorException

Creates a model instance.

Parameters:

ctx -

synchronous -

model -

properties -

Returns:

created model instance

Throws:

ErrorException

createModelInstance

RecordHolder createModelInstance(ExecutionContext ctx,
                                 Boolean synchronous,
                                 RecordHolder model,
                                 RecordHolder processEntity,
                                 MapHolder properties)
                          throws ErrorException

Creates a model instance with a specified process entity record.

Parameters:

ctx -

synchronous -

model -

processEntity -

properties -

Returns:

the created model instance

Throws:

ErrorException

notifyModelInstance

void notifyModelInstance(ExecutionContext ctx,
                         Decimal modelInstanceId,
                         String reason,
                         Boolean synchronously)
                  throws ErrorException

Notify provided model instance.

Parameters:

ctx -

modelInstanceId -

reason - string used for logging

synchronously -

Throws:

ErrorException

log

void log(ExecutionContext ctx,
         String message,
         Decimal level)
  throws ErrorException

Logs a message to the application log on specified level.

Parameters:

ctx -

message -

level -

Throws:

ErrorException

evaluateExpression

Object evaluateExpression(ExecutionContext ctx,
                          Boolean isFullExecutionMode,
                          ClosureHolder expression)
                   throws ErrorException

This method evaluates an expression defined in the closure using defined evaluationMode. If the isFullExecutionMode = true then the expression is evaluated in an ordinary execution context in which this function is called. SharedRecords are treated as in standard execution. If the isFullExecutionMode = false the expression is executed in an auxiliary execution contexts. The original contexts of the model instance are not affected. The auxiliary contexts and values are stored in the model instance, so they are persisted together with the model instance. Shared records are not created, instead an auxiliary (non-shared) records are used. Therefore shared records created during evaluation are not returned by queries. Auxiliary contexts and values can be cleaned, all auxiliary contexts and values are removed from the model instance. In such a case all changes caused by the evaluation are removed. Auxiliary contexts and values can be merged to the original execution contexts and values. After such merge the auxiliary contexts and values are cleaned. During the merge shared records are created for all shared records created during evaluation. Evaluation of an expression in 'isFullexecutionMode = false' mode and merging it to original context is not fully equivalent to the evaluation of the expression in the 'isFullExecutionMode = true' mode as the execution of queries can have different results. If the result of the execution is not of a simple type. It will be discarded by a cleanEvaluation method.

Parameters:

ctx -

isFullExecutionMode -

expression -

Returns:

result of evaluation

Throws:

ErrorException

cleanEvaluation

void cleanEvaluation(ExecutionContext ctx)

Cleans auxiliary contexts and values used by the evaluation in the 'isFullExecutionMode = false' mode. All auxiliary contexts and values are removed from the model instance. In such a case all changes caused by the evaluation are removed.

Parameters:

ctx -

mergeEvaluation

void mergeEvaluation(ExecutionContext ctx)
              throws ErrorException

Merges auxiliary contexts and values to the original execution contexts and values. After such merge the auxiliary contexts and values are cleaned. During the merge shared records are created for all shared records created during evaluation.

Parameters:

ctx -

Throws:

ErrorException

debugLog

String debugLog(ExecutionContext ctx,
                ClosureHolder message)
         throws ErrorException

Logs a message to the console at the debug logging level. If logging is not enabled for the debug level, the message closure is not even evaluated. The function returns a string that was logged, or null if the message was not logged. Logs given message through java.util.logging subsystem on Level.FINE.

Parameters:

ctx -

message -

Returns:

The message as a string.

Throws:

ErrorException

debugLog

String debugLog(ExecutionContext ctx,
                ClosureHolder message,
                Decimal level)
         throws ErrorException

Logs a message to the console at the specified logging level. If logging is not enabled at the specified level, the message closure is not even evaluated. The function returns a string that was logged, or null if the message was not logged. Logs given message through java.util.logging subsystem on specified level. level <= 100 -> Level.FINE level <= 200 -> Level.INFO level <= 300 -> Level.WARNING level <= 400 -> Level.SEVERE

Parameters:

ctx -

message -

level -

Returns:

The message as a string.

Throws:

ErrorException

deleteAllRecords

void deleteAllRecords(ExecutionContext ctx,
                      CollectionHolder records)
               throws ErrorException

Deletes the specified records and all related data links navigable from the deleted records. Works for shared and for non-shared records. Value of deleted records become null in all slots (variables, function or task call parameters, etc.) referring to that records.

Parameters:

ctx -

records -

Throws:

ErrorException

deleteRecords

void deleteRecords(ExecutionContext ctx,
                   RecordHolder... records)
            throws ErrorException

Deletes the specified records and all related data links navigable from the deleted records. Works for shared and for non-shared records. Value of deleted records become null in all slots (variables, function or task call parameters, etc.) referring to that records.

Parameters:

ctx -

records -

Throws:

ErrorException

throwEscalation

void throwEscalation(ExecutionContext ctx,
                     String escalationCode,
                     Object payload)
              throws ErrorException

Throws an escalation event with the escalation code and optional payload. The escalation code can be used by the escalation handler to decide whether to handle the escalation or not.* The payload allows to provide additional information for the escalation handler about the escalation event.

Parameters:

ctx -

escalationCode - the code of the escalation

payload - the escalation payload (optional)

Throws:

ErrorException

createInstance

RecordHolder createInstance(ExecutionContext ctx,
                            Type type,
                            MapHolder values)
                     throws ErrorException

Creates new instance of record type T. If the properties are specified, the instance is initialized with the specified values of properties.

Parameters:

ctx -

type -

values -

Returns:

RecordHolder

Throws:

ErrorException

createProxy

RecordHolder createProxy(ExecutionContext ctx,
                         Object record,
                         Property... properties)

Creates a change proxy on the record that keeps all changes. Creates change proxies on properties.

Parameters:

ctx -

record -

properties -

Returns:

a proxy on the record that keeps all changes

createProxy

RecordHolder createProxy(ExecutionContext ctx,
                         Type type)
                  throws ErrorException

Creates a proxy without proxied record. It can be used only for shared records. When merged a shared record is created.

Parameters:

ctx -

type -

Returns:

proxy without proxied record

Throws:

ErrorException

createProxy

RecordHolder createProxy(ExecutionContext ctx,
                         Type type,
                         Decimal proxyLevel)
                  throws ErrorException

Creates a proxy without proxied record. It can be used only for shared records. It creates all chain of proxies from proxy level 1 to target proxy level

Parameters:

ctx -

type -

proxyLevel -

Returns:

proxy without proxied record

Throws:

ErrorException

createProxy

ListHolder createProxy(ExecutionContext ctx,
                       ListHolder list,
                       Property... properties)

Creates a list of record proxies. For records it makes proxies for the specified properties.

Parameters:

ctx -

list -

properties -

Returns:

the list of proxy records

createProxy

SetHolder createProxy(ExecutionContext ctx,
                      SetHolder set,
                      Property... properties)

Creates a set of record proxies. For records it makes proxies for the specified properties.

Parameters:

ctx -

set -

properties -

Returns:

the set of proxy records

createProxyOfProperties

void createProxyOfProperties(ExecutionContext ctx,
                             RecordHolder record,
                             Property... properties)

Creates change proxy for all object referenced by the propery and sets the proxy values to the property.

Parameters:

ctx -

record -

properties -

mergeProxies

ListHolder mergeProxies(ExecutionContext ctx,
                        Boolean checkConflicts,
                        Object... records)
                 throws ErrorException,
                        LspsException

Merges changes from the proxies to the proxied records.

Parameters:

ctx -

checkConflicts -

records -

Returns:

returns proxied records with applied changes

Throws:

ErrorException

LspsException

mergeProxies

ListHolder mergeProxies(ExecutionContext ctx,
                        Object... records)
                 throws ErrorException,
                        LspsException

Merges changes from the proxies to the proxied records.

Parameters:

ctx -

records -

Returns:

returns proxied records with applied changes

Throws:

ErrorException

LspsException

mergeAllProxies

ListHolder mergeAllProxies(ExecutionContext ctx,
                           Boolean checkConflicts,
                           CollectionHolder records)
                    throws LspsException

Merges changes from the proxies to the proxied records.

Parameters:

ctx -

checkConflicts -

records -

Returns:

returns proxied records with applied changes

Throws:

LspsException

mergeAllProxies

ListHolder mergeAllProxies(ExecutionContext ctx,
                           CollectionHolder records)
                    throws LspsException

Merges changes from the proxies to the proxied records.

Parameters:

ctx -

records -

Returns:

returns proxied records with applied changes

Throws:

LspsException

mergeProxiesDeep

ListHolder mergeProxiesDeep(ExecutionContext ctx,
                            Boolean checkConflicts,
                            Object... records)
                     throws LspsException

Merges changes from the proxies to the proxied records. It merges changes from all proxies that can be accessed from the record and has same proxy level. It returns proxied records with applied changes.

Parameters:

ctx -

checkConflicts -

records -

Returns:

returns proxied records with applied changes

Throws:

LspsException

mergeProxiesDeep

ListHolder mergeProxiesDeep(ExecutionContext ctx,
                            Object... records)
                     throws LspsException

Merges changes from the proxies to the proxied records. It merges changes from all proxies that can be accessed from the record and has same proxy level. It returns proxied records with applied changes.

Parameters:

ctx -

records -

Returns:

returns proxied records with applied changes

Throws:

LspsException

mergeAllProxiesDeep

ListHolder mergeAllProxiesDeep(ExecutionContext ctx,
                               Boolean checkConflicts,
                               CollectionHolder records)
                        throws LspsException

Merges changes from the proxies to the proxied records. It merges changes from all proxies that can be accessed from the record and has same proxy level. It returns proxied records with applied changes.

Parameters:

ctx -

checkConflicts -

records -

Returns:

returns proxied records with applied changes

Throws:

LspsException

mergeAllProxiesDeep

ListHolder mergeAllProxiesDeep(ExecutionContext ctx,
                               CollectionHolder records)
                        throws LspsException

Merges changes from the proxies to the proxied records. It merges changes from all proxies that can be accessed from the record and has same proxy level. It returns proxied records with applied changes.

Parameters:

ctx -

records -

Returns:

returns proxied records with applied changes

Throws:

LspsException

getProxyLevel

Decimal getProxyLevel(ExecutionContext ctx,
                      RecordHolder record)
               throws LspsException

Returns proxy level of the record.

Parameters:

ctx -

record -

Returns:

proxy level of the record.

Throws:

LspsException