com.whitestein.lsps.stdlib.function

Interface ReflectionFunctions

All Known Implementing Classes:

ReflectionFunctionsImpl

public interface ReflectionFunctions

Author:

rba

Method Summary

Modifier and Type	Method and Description
java.lang.String	achieved() Get ACHIEVED state name
void	activate(ExecutionContext ctx, CollectionHolder goals) (Re)activates inactive or finished goals.
java.lang.String	active() Get ACTIVE state name
java.lang.String	alive() Get ALIVE state name
void	deactivate(ExecutionContext ctx, CollectionHolder goals) Deactivates not finished goals.
java.lang.String	deactivated() Get DEACTIVATED state name
java.lang.String	failed() Get FAILED state name
SetHolder	findModelInstances(ExecutionContext context, java.lang.String model, java.lang.String version, java.lang.Boolean isRunning, MapHolder properties) Returns a set of model instances satisfying the specified criteria.
SetHolder	findModels(ExecutionContext ctx, java.lang.String name, java.lang.String version, java.lang.Boolean latestOnly) Returns a set of all uploaded models satisfying the specified filtering criteria.
SetHolder	findProcessInstances(ExecutionContext context, ClosureHolder filter) Returns a set of process instances satisfying the specified filtering criteria.
SetHolder	findProcessInstances(ExecutionContext context, RecordHolder modelInstance, ClosureHolder filter) Returns a set of process instances for a model instance satisfying the specified filtering criteria.
java.lang.String	finished() Get FINISHED state name
MapHolder	getBinaryDataMetadata(ExecutionContext context, RecordHolder binaryData) Returns map of metadata of binary data.
Decimal	getCurrentInvocationTimestamp(ExecutionContext ctx) Returns current invocation timestamp.
RecordHolder	getModel(ExecutionContext ctx, java.lang.String name) Returns a model with the specified name or null, if there is no such a model.
RecordHolder	getModel(ExecutionContext ctx, java.lang.String name, java.lang.String version) Returns a model with the specified name and version, or null, if there is no such a model instance.
RecordHolder	getModelInstance(ExecutionContext context, Decimal id) Returns a model instance with the specified id.
MapHolder	getModelInstanceProperties(ExecutionContext context, RecordHolder modelInstance) Returns a map of initialization properties of the specified model instance.
RecordHolder	getProcessEntity(ExecutionContext ctx, Type type) Returns the associated process entity.
java.lang.String	inactive() Get INACTIVE state name
java.lang.Boolean	isInState(ExecutionContext ctx, RecordHolder goalPlan, java.lang.String state) Returns true if a goalPlan is in the specified state or any of its sub-states
java.lang.Boolean	isProxy(ExecutionContext ctx, RecordHolder record) Returns true if the record is proxy.
java.lang.String	notFinished() Get NOT FINISHED state name
java.lang.String	ready() Get READY state name
java.lang.String	running() Get RUNNING state name
void	terminateModelInstance(ExecutionContext context, RecordHolder modelInstance) Terminates given model instance
RecordHolder	thisModel(ExecutionContext ctx)
RecordHolder	thisModelInstance(ExecutionContext ctx)
MapHolder	thisModelInstanceProperties(ExecutionContext ctx) Returns a map of initialization properties of the model instance that executed this function.
java.lang.String	thisModelInstanceProperty(ExecutionContext ctx, java.lang.String propertyName) Returns a value of the initialization property of the given name of the model instance that executed this function.
ProcessInstanceHolder	thisProcessInstance(ExecutionContext ctx)

Method Detail

isInState

java.lang.Boolean isInState(ExecutionContext ctx,
                            RecordHolder goalPlan,
                            java.lang.String state)
                     throws ErrorException

Returns true if a goalPlan is in the specified state or any of its sub-states

Parameters:

ctx -

goalPlan -

state -

Returns:

Returns true if a goalPlan is in the specified state or any of its sub-states

Throws:

ErrorException

alive

java.lang.String alive()

Get ALIVE state name

Returns:

state name

notFinished

java.lang.String notFinished()

Get NOT FINISHED state name

Returns:

state name

inactive

java.lang.String inactive()

Get INACTIVE state name

Returns:

state name

active

java.lang.String active()

Get ACTIVE state name

Returns:

state name

ready

java.lang.String ready()

Get READY state name

Returns:

state name

running

java.lang.String running()

Get RUNNING state name

Returns:

state name

finished

java.lang.String finished()

Get FINISHED state name

Returns:

state name

achieved

java.lang.String achieved()

Get ACHIEVED state name

Returns:

state name

failed

java.lang.String failed()

Get FAILED state name

Returns:

state name

deactivated

java.lang.String deactivated()

Get DEACTIVATED state name

Returns:

state name

thisModel

RecordHolder thisModel(ExecutionContext ctx)

Parameters:

ctx -

Returns:

current model of current model instance

thisModelInstance

RecordHolder thisModelInstance(ExecutionContext ctx)

Parameters:

ctx -

Returns:

current model instance

thisModelInstanceProperties

MapHolder thisModelInstanceProperties(ExecutionContext ctx)
                               throws ErrorException

Returns a map of initialization properties of the model instance that executed this function. Returns null if executed from document.

Parameters:

ctx -

Returns:

a map of properties

Throws:

ErrorException

thisModelInstanceProperty

java.lang.String thisModelInstanceProperty(ExecutionContext ctx,
                                           java.lang.String propertyName)
                                    throws ErrorException

Returns a value of the initialization property of the given name of the model instance that executed this function. Returns null if there is no property with a given name or if executed from document.

Parameters:

ctx -

propertyName -

Returns:

a property value

Throws:

ErrorException

getProcessEntity

RecordHolder getProcessEntity(ExecutionContext ctx,
                              Type type)
                       throws ErrorException

Returns the associated process entity. Process entity information (its primary key) is stored in the model instance properties.

Parameters:

ctx -

type -

Returns:

the process entity or null

Throws:

ErrorException

thisProcessInstance

ProcessInstanceHolder thisProcessInstance(ExecutionContext ctx)

Parameters:

ctx -

Returns:

current process instance

getModel

RecordHolder getModel(ExecutionContext ctx,
                      java.lang.String name)
               throws ErrorException

Returns a model with the specified name or null, if there is no such a model. If there are several models with the same name (and arbitrary version) on the server, the most recently uploaded model is returned.

Parameters:

ctx -

name -

Returns:

a model with the specified name

Throws:

ErrorException

getModel

RecordHolder getModel(ExecutionContext ctx,
                      java.lang.String name,
                      java.lang.String version)
               throws ErrorException

Returns a model with the specified name and version, or null, if there is no such a model instance. If there are several models with the same name and version on the server, the most recently uploaded model is returned.

Parameters:

ctx -

name -

version -

Returns:

a model with the specified name and version

Throws:

ErrorException

findModels

SetHolder findModels(ExecutionContext ctx,
                     java.lang.String name,
                     java.lang.String version,
                     java.lang.Boolean latestOnly)

Returns a set of all uploaded models satisfying the specified filtering criteria. If the corresponding fields of a model match the patterns specified as function parameters, the model is included in the resulting set. All strings in parameters are specified as wildcard strings patterns. A wildcard string can contain the following wildcards: “*” matching none or several arbitrary characters, and “?” matching exactly one arbitrary character. Any other character in patterns matches itself. �null’ specified as the pattern value matches any value of the model field (which is equivalent to the “*” pattern). Setting the latestOnly parameter to true causes including only the most recently uploaded models with given name and version, if there are several models with the same name and version on the server. If the latestOnly parameter is set to false, all models satisfying the filtering criteria are returned; the returned set can contain several models of the same name and version.

Parameters:

ctx -

name -

version -

latestOnly -

Returns:

a set of all uploaded models satisfying the specified filtering criteria

findModelInstances

SetHolder findModelInstances(ExecutionContext context,
                             java.lang.String model,
                             java.lang.String version,
                             java.lang.Boolean isRunning,
                             MapHolder properties)

Returns a set of model instances satisfying the specified criteria.

Parameters:

context -

model -

version -

isRunning -

properties -

Returns:

a set of model instances satisfying the specified criteria

getModelInstance

RecordHolder getModelInstance(ExecutionContext context,
                              Decimal id)
                       throws ErrorException

Returns a model instance with the specified id.

Parameters:

context -

id -

Returns:

a model instance with the specified id

Throws:

ErrorException

findProcessInstances

SetHolder findProcessInstances(ExecutionContext context,
                               ClosureHolder filter)
                        throws ErrorException

Returns a set of process instances satisfying the specified filtering criteria.

Parameters:

context -

filter -

Returns:

a set of process instances satisfying the specified filtering criteria

Throws:

ErrorException

findProcessInstances

SetHolder findProcessInstances(ExecutionContext context,
                               RecordHolder modelInstance,
                               ClosureHolder filter)
                        throws ErrorException

Returns a set of process instances for a model instance satisfying the specified filtering criteria.

Parameters:

context -

modelInstance -

filter -

Returns:

a set of process instances satisfying the specified filtering criteria

Throws:

ErrorException

getModelInstanceProperties

MapHolder getModelInstanceProperties(ExecutionContext context,
                                     RecordHolder modelInstance)
                              throws ErrorException

Returns a map of initialization properties of the specified model instance.

Parameters:

context -

modelInstance -

Returns:

a map of initialization properties of the specified model instance

Throws:

ErrorException

getBinaryDataMetadata

MapHolder getBinaryDataMetadata(ExecutionContext context,
                                RecordHolder binaryData)
                         throws ErrorException

Returns map of metadata of binary data.

Parameters:

context -

binaryData -

Returns:

map of metadata of binary data

Throws:

ErrorException

activate

void activate(ExecutionContext ctx,
              CollectionHolder goals)
       throws ErrorException

(Re)activates inactive or finished goals. If a goal from the collection is active, the function type does nothing with its state.

Parameters:

ctx -

goals -

Throws:

ErrorException

deactivate

void deactivate(ExecutionContext ctx,
                CollectionHolder goals)
         throws ErrorException

Deactivates not finished goals. If a goal from the collection is finished or the goal’s process is finished, the task type does nothing with it.

Parameters:

ctx -

goals -

Throws:

ErrorException

getCurrentInvocationTimestamp

Decimal getCurrentInvocationTimestamp(ExecutionContext ctx)

Returns current invocation timestamp.

Parameters:

ctx -

Returns:

current invocation timestamp

isProxy

java.lang.Boolean isProxy(ExecutionContext ctx,
                          RecordHolder record)
                   throws ErrorException

Returns true if the record is proxy.

Parameters:

ctx -

record -

Returns:

true if the record is proxy

Throws:

ErrorException

terminateModelInstance

void terminateModelInstance(ExecutionContext context,
                            RecordHolder modelInstance)
                     throws ErrorException

Terminates given model instance

Parameters:

context -

modelInstance -

Throws:

ErrorException