com.whitestein.lsps.stdlib.function

Class ReflectionFunctionsImpl

java.lang.Object

com.whitestein.lsps.stdlib.function.ReflectionFunctionsImpl

All Implemented Interfaces:

ReflectionFunctions

@PermitAll
public class ReflectionFunctionsImpl
extends Object
implements ReflectionFunctions

Functions for reflection types.

Constructor Summary

Constructors

Constructor and Description
ReflectionFunctionsImpl() Creates new instance.
ReflectionFunctionsImpl(ModelManagementDao modelManagementDao, ModelInstanceDao modelInstanceDao, CoreTypeFactory coreTypeFactory, CommunicationService communicationService) Creates new instance.

Method Summary

Modifier and Type	Method and Description
String	achieved() Get ACHIEVED state name
void	activate(ExecutionContext ctx, CollectionHolder goals) (Re)activates inactive or finished goals.
String	active() Get ACTIVE state name
String	alive() Get ALIVE state name
void	deactivate(ExecutionContext ctx, CollectionHolder goals) Deactivates not finished goals.
String	deactivated() Get DEACTIVATED state name
String	failed() Get FAILED state name
SetHolder	findModelInstances(ExecutionContext context, String model, String version, Boolean isRunning, MapHolder properties) Returns a set of model instances satisfying the specified criteria.
SetHolder	findModels(ExecutionContext ctx, String name, String version, 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.
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, String name) Returns a model with the specified name or null, if there is no such a model.
RecordHolder	getModel(ExecutionContext ctx, String name, 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.
String	inactive() Get INACTIVE state name
Boolean	isInState(ExecutionContext ctx, RecordHolder goalPlan, String state) Returns true if a goalPlan is in the specified state or any of its sub-states
Boolean	isProxy(ExecutionContext ctx, RecordHolder record) Returns true if the record is proxy.
String	notFinished() Get NOT FINISHED state name
String	ready() Get READY state name
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.
String	thisModelInstanceProperty(ExecutionContext ctx, 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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReflectionFunctionsImpl

public ReflectionFunctionsImpl()

Creates new instance.

ReflectionFunctionsImpl

public ReflectionFunctionsImpl(ModelManagementDao modelManagementDao,
                               ModelInstanceDao modelInstanceDao,
                               CoreTypeFactory coreTypeFactory,
                               CommunicationService communicationService)

Creates new instance.

Parameters:

modelManagementDao - the model management dao

modelInstanceDao - the model instance dao

coreTypeFactory - the core type factory

communicationService - the communication service

Method Detail

isInState

public Boolean isInState(ExecutionContext ctx,
                         RecordHolder goalPlan,
                         String state)
                  throws ErrorException

Description copied from interface: ReflectionFunctions

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

Specified by:

isInState in interface ReflectionFunctions

Returns:

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

Throws:

ErrorException

alive

public String alive()

Description copied from interface: ReflectionFunctions

Get ALIVE state name

Specified by:

alive in interface ReflectionFunctions

Returns:

state name

notFinished

public String notFinished()

Description copied from interface: ReflectionFunctions

Get NOT FINISHED state name

Specified by:

notFinished in interface ReflectionFunctions

Returns:

state name

inactive

public String inactive()

Description copied from interface: ReflectionFunctions

Get INACTIVE state name

Specified by:

inactive in interface ReflectionFunctions

Returns:

state name

active

public String active()

Description copied from interface: ReflectionFunctions

Get ACTIVE state name

Specified by:

active in interface ReflectionFunctions

Returns:

state name

ready

public String ready()

Description copied from interface: ReflectionFunctions

Get READY state name

Specified by:

ready in interface ReflectionFunctions

Returns:

state name

running

public String running()

Description copied from interface: ReflectionFunctions

Get RUNNING state name

Specified by:

running in interface ReflectionFunctions

Returns:

state name

finished

public String finished()

Description copied from interface: ReflectionFunctions

Get FINISHED state name

Specified by:

finished in interface ReflectionFunctions

Returns:

state name

achieved

public String achieved()

Description copied from interface: ReflectionFunctions

Get ACHIEVED state name

Specified by:

achieved in interface ReflectionFunctions

Returns:

state name

failed

public String failed()

Description copied from interface: ReflectionFunctions

Get FAILED state name

Specified by:

failed in interface ReflectionFunctions

Returns:

state name

deactivated

public String deactivated()

Description copied from interface: ReflectionFunctions

Get DEACTIVATED state name

Specified by:

deactivated in interface ReflectionFunctions

Returns:

state name

thisModelInstance

public RecordHolder thisModelInstance(ExecutionContext ctx)

Specified by:

thisModelInstance in interface ReflectionFunctions

Returns:

current model instance

thisModelInstanceProperties

public MapHolder thisModelInstanceProperties(ExecutionContext ctx)

Description copied from interface: ReflectionFunctions

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

Specified by:

thisModelInstanceProperties in interface ReflectionFunctions

Returns:

a map of properties

thisModelInstanceProperty

public String thisModelInstanceProperty(ExecutionContext ctx,
                                        String propertyName)
                                 throws ErrorException

Description copied from interface: ReflectionFunctions

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.

Specified by:

thisModelInstanceProperty in interface ReflectionFunctions

Returns:

a property value

Throws:

ErrorException

getProcessEntity

public RecordHolder getProcessEntity(ExecutionContext ctx,
                                     Type type)
                              throws ErrorException

Description copied from interface: ReflectionFunctions

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

Specified by:

getProcessEntity in interface ReflectionFunctions

Returns:

the process entity or null

Throws:

ErrorException

thisProcessInstance

public ProcessInstanceHolder thisProcessInstance(ExecutionContext ctx)

Specified by:

thisProcessInstance in interface ReflectionFunctions

Returns:

current process instance

thisModel

public RecordHolder thisModel(ExecutionContext ctx)

Specified by:

thisModel in interface ReflectionFunctions

Returns:

current model of current model instance

getModel

public RecordHolder getModel(ExecutionContext ctx,
                             String name)
                      throws ErrorException

Description copied from interface: ReflectionFunctions

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.

Specified by:

getModel in interface ReflectionFunctions

Returns:

a model with the specified name

Throws:

ErrorException

getModel

public RecordHolder getModel(ExecutionContext ctx,
                             String name,
                             String version)
                      throws ErrorException

Description copied from interface: ReflectionFunctions

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.

Specified by:

getModel in interface ReflectionFunctions

Returns:

a model with the specified name and version

Throws:

ErrorException

findModels

public SetHolder findModels(ExecutionContext ctx,
                            String name,
                            String version,
                            Boolean latestOnly)

Description copied from interface: ReflectionFunctions

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.

Specified by:

findModels in interface ReflectionFunctions

Returns:

a set of all uploaded models satisfying the specified filtering criteria

findModelInstances

public SetHolder findModelInstances(ExecutionContext context,
                                    String model,
                                    String version,
                                    Boolean isRunning,
                                    MapHolder properties)

Description copied from interface: ReflectionFunctions

Returns a set of model instances satisfying the specified criteria.

Specified by:

findModelInstances in interface ReflectionFunctions

Returns:

a set of model instances satisfying the specified criteria

getModelInstance

public RecordHolder getModelInstance(ExecutionContext context,
                                     Decimal id)
                              throws ErrorException

Description copied from interface: ReflectionFunctions

Returns a model instance with the specified id.

Specified by:

getModelInstance in interface ReflectionFunctions

Returns:

a model instance with the specified id

Throws:

ErrorException

findProcessInstances

public SetHolder findProcessInstances(ExecutionContext context,
                                      ClosureHolder filter)
                               throws ErrorException

Description copied from interface: ReflectionFunctions

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

Specified by:

findProcessInstances in interface ReflectionFunctions

Returns:

a set of process instances satisfying the specified filtering criteria

Throws:

ErrorException

findProcessInstances

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

Description copied from interface: ReflectionFunctions

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

Specified by:

findProcessInstances in interface ReflectionFunctions

Returns:

a set of process instances satisfying the specified filtering criteria

Throws:

ErrorException

getModelInstanceProperties

public MapHolder getModelInstanceProperties(ExecutionContext context,
                                            RecordHolder modelInstance)
                                     throws ErrorException

Description copied from interface: ReflectionFunctions

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

Specified by:

getModelInstanceProperties in interface ReflectionFunctions

Returns:

a map of initialization properties of the specified model instance

Throws:

ErrorException

getBinaryDataMetadata

public MapHolder getBinaryDataMetadata(ExecutionContext context,
                                       RecordHolder binaryData)
                                throws ErrorException

Description copied from interface: ReflectionFunctions

Returns map of metadata of binary data.

Specified by:

getBinaryDataMetadata in interface ReflectionFunctions

Returns:

map of metadata of binary data

Throws:

ErrorException

activate

public void activate(ExecutionContext ctx,
                     CollectionHolder goals)
              throws ErrorException

Description copied from interface: ReflectionFunctions

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

Specified by:

activate in interface ReflectionFunctions

Throws:

ErrorException

deactivate

public void deactivate(ExecutionContext ctx,
                       CollectionHolder goals)
                throws ErrorException

Description copied from interface: ReflectionFunctions

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.

Specified by:

deactivate in interface ReflectionFunctions

Throws:

ErrorException

getCurrentInvocationTimestamp

public Decimal getCurrentInvocationTimestamp(ExecutionContext ctx)

Description copied from interface: ReflectionFunctions

Returns current invocation timestamp.

Specified by:

getCurrentInvocationTimestamp in interface ReflectionFunctions

Returns:

current invocation timestamp

isProxy

public Boolean isProxy(ExecutionContext ctx,
                       RecordHolder record)
                throws ErrorException

Description copied from interface: ReflectionFunctions

Returns true if the record is proxy.

Specified by:

isProxy in interface ReflectionFunctions

Returns:

true if the record is proxy

Throws:

ErrorException

terminateModelInstance

public void terminateModelInstance(ExecutionContext context,
                                   RecordHolder modelInstance)
                            throws ErrorException

Description copied from interface: ReflectionFunctions

Terminates given model instance

Specified by:

terminateModelInstance in interface ReflectionFunctions

Throws:

ErrorException