com.whitestein.lsps.engine

Interface ModelProviderClientService

All Known Subinterfaces:

ModelProviderService

All Known Implementing Classes:

ModelProviderServiceBean

public interface ModelProviderClientService

Service that provides model related utilities in web container.

Author:

bhl

Method Summary

Modifier and Type	Method and Description
AllocatedModelInstanceResources	allocateDetachmentAndValueIds(long modelInstanceId, long allocatedSize) Allocates new range of value ids and detachment id.
AllocatedModelInstanceResources	allocateValueIds(long modelInstanceId, long allocatedSize) Allocates new range of value ids.
EvaluationResult	evaluateExpression(long modelInstanceId, Long contextId, String source, boolean fullExecutionModel, boolean mergeEvaluation) Parses the string to the expression and than evaluates it in the top context of the model instance.
EvaluationResult	evaluateExpression(long modelInstanceId, Long contextId, String source, String evaluationLevel, boolean mergeEvaluation) Parses the string to the expression and than evaluates it in the top context of the model instance.
EvaluationResult	evaluateExpression(long modelInstanceId, String source, boolean fullExecutionModel) Parses the string to the expression and than evaluates it in the top context of the model instance.
EvaluationResult	evaluateExpression(long modelInstanceId, String source, boolean fullExecutionModel, boolean mergeEvaluation) Parses the string to the expression and than evaluates it in the top context of the model instance.
EvaluationResult	evaluateExpression(long modelInstanceId, String source, String evaluationLevel, boolean mergeEvaluation) Parses the string to the expression and than evaluates it in the top context of the model instance.
EvaluationResult	evaluateExpressionInModel(long modelId, String source, boolean fullExecutionModel) Parses the string to the expression and than evaluates it in the empty model context
List<EvaluationResult>	evaluateExpressions(long modelInstanceId, List<String> sources, boolean fullExecutionModel) Parses the string sources of expressions in the list evaluates them end returns list of results.
List<EvaluationResult>	evaluateExpressionsInModel(long modelId, List<String> sources, boolean fullExecutionModel) Parses the string sources of expressions in the list evaluates them end returns list of results.
void	flushAll() Deprecated.
void	flushModelSessions(long moduleId) Flush of sessions for all model shared records.
CompatibilityVersion	getCompatibilityVersion(long modelId) Returns compatibility version for the module.
ComponentService	getComponentService() Answer component service instance
ExecutionContext	getExecutionContext(long modelInstanceId) Returns an execution context for the given model instance id or null if it does not exist.
ExecutionContext	getExecutionContext(long modelInstanceId, long contextId) Returns an execution context for the given context in the model instance or null if it does not exist.
ExecutionContext	getExecutionContext(long modelInstanceId, long contextId, String level) Returns an execution context for the given context in the model instance or null if it does not exist.
ExecutionContext	getExecutionContext(long modelId, ModelInstanceType modelInstanceType, String level) Returns an execution context for the given model or null if it does not exist.
ExecutionContext	getPersistentExecutionContext(long modelId, ModelInstanceType type, String evaluationLevel) Returns an execution context for the given model or null if it does not exist.
RecordType	getRecordTypeForEntity(Object object, long modelId) Returns record type for entity.
TransactionSynchronizationRegistry	getTransactionSynchronizationRegistry() Returns transaction synchronization registry.
com.whitestein.lsps.model.ProcessModel	loadProcessModel(long moduleId) INTERNAL API: Loads a process model into the cache.
com.whitestein.lsps.model.ProcessModel	loadProcessModel(String modelHash) INTERNAL API: Loads a process model into the cache.
EnumerationType	resolveEnumerationType(long moduleId, String qualifiedName) Resolves enumeration type by its qualified name in given model.
RecordType	resolveRecordType(long moduleId, String qualifiedName) Resolves record by its qualified name in given model.
Type	resolveType(long moduleId, String qualifiedName) Resolves type by its qualified name in given model.
void	synchronizeCache() Synchronize cache.

Method Detail

getTransactionSynchronizationRegistry

TransactionSynchronizationRegistry getTransactionSynchronizationRegistry()

Returns transaction synchronization registry.

Returns:

transaction synchronization registry

loadProcessModel

com.whitestein.lsps.model.ProcessModel loadProcessModel(long moduleId)
                                                 throws ModelUploadException

INTERNAL API: Loads a process model into the cache.

Parameters:

moduleId - id of model to load

Returns:

process model

Throws:

ModelUploadException

loadProcessModel

com.whitestein.lsps.model.ProcessModel loadProcessModel(String modelHash)
                                                 throws ModelUploadException

INTERNAL API: Loads a process model into the cache.

Parameters:

modelHash - hash of the model to load

Returns:

process model

Throws:

ModelUploadException

synchronizeCache

void synchronizeCache()

Synchronize cache. Can be used for nodes in a cluster.

flushModelSessions

void flushModelSessions(long moduleId)

Flush of sessions for all model shared records.

Parameters:

moduleId -

flushAll

@Deprecated
void flushAll()

Deprecated.

Flushes all sessions used in this transaction

resolveType

Type resolveType(long moduleId,
                 String qualifiedName)
          throws ValidationException

Resolves type by its qualified name in given model.

Parameters:

moduleId -

qualifiedName -

Returns:

resolved type

Throws:

ValidationException

resolveRecordType

RecordType resolveRecordType(long moduleId,
                             String qualifiedName)
                      throws ValidationException

Resolves record by its qualified name in given model. It throws exception null if no such record exists.

Parameters:

moduleId -

qualifiedName -

Returns:

resolved record type

Throws:

IllegalArgumentException - if model with given id does not exist

ValidationException

resolveEnumerationType

EnumerationType resolveEnumerationType(long moduleId,
                                       String qualifiedName)
                                throws ValidationException

Resolves enumeration type by its qualified name in given model. It returns null if no such type exists.

Parameters:

moduleId -

qualifiedName -

Returns:

resolved enumeration type or NullPointerException

Throws:

IllegalArgumentException - if model with given id does not exist

ValidationException

evaluateExpression

EvaluationResult evaluateExpression(long modelInstanceId,
                                    String source,
                                    boolean fullExecutionModel,
                                    boolean mergeEvaluation)
                             throws ValidationException,
                                    ErrorException

Parses the string to the expression and than evaluates it in the top context of the model instance.

Parameters:

modelInstanceId -

source -

fullExecutionModel -

mergeEvaluation -

Returns:

result of the expression evaluation

Throws:

ValidationException

ErrorException

LspsRuntimeException - if the model instance is not found

evaluateExpression

EvaluationResult evaluateExpression(long modelInstanceId,
                                    Long contextId,
                                    String source,
                                    boolean fullExecutionModel,
                                    boolean mergeEvaluation)
                             throws ValidationException,
                                    ErrorException

Parses the string to the expression and than evaluates it in the top context of the model instance.

Parameters:

modelInstanceId -

contextId -

source -

fullExecutionModel -

mergeEvaluation -

Returns:

result of the expression evaluation

Throws:

ValidationException

ErrorException

LspsRuntimeException - if the model instance is not found

evaluateExpression

EvaluationResult evaluateExpression(long modelInstanceId,
                                    String source,
                                    String evaluationLevel,
                                    boolean mergeEvaluation)
                             throws ValidationException,
                                    ErrorException

Parses the string to the expression and than evaluates it in the top context of the model instance.

Parameters:

modelInstanceId -

source -

evaluationLevel -

mergeEvaluation -

Returns:

result of the expression evaluation

Throws:

ValidationException

ErrorException

LspsRuntimeException - if the model instance is not found

evaluateExpression

EvaluationResult evaluateExpression(long modelInstanceId,
                                    Long contextId,
                                    String source,
                                    String evaluationLevel,
                                    boolean mergeEvaluation)
                             throws ValidationException,
                                    ErrorException

Parses the string to the expression and than evaluates it in the top context of the model instance.

Parameters:

modelInstanceId -

contextId -

source -

evaluationLevel -

mergeEvaluation -

Returns:

result of the expression evaluation

Throws:

ValidationException

ErrorException

LspsRuntimeException - if the model instance is not found

evaluateExpression

EvaluationResult evaluateExpression(long modelInstanceId,
                                    String source,
                                    boolean fullExecutionModel)
                             throws ValidationException,
                                    ErrorException

Parses the string to the expression and than evaluates it in the top context of the model instance.

Parameters:

modelInstanceId -

source -

fullExecutionModel -

Returns:

result of the expression evaluation

Throws:

ValidationException

ErrorException

LspsRuntimeException - if the model instance is not found

evaluateExpressionsInModel

List<EvaluationResult> evaluateExpressionsInModel(long modelId,
                                                  List<String> sources,
                                                  boolean fullExecutionModel)
                                           throws ValidationException,
                                                  ErrorException

Parses the string sources of expressions in the list evaluates them end returns list of results.

Parameters:

modelId -

sources -

fullExecutionModel -

Returns:

list of results

Throws:

ValidationException

ErrorException

LspsRuntimeException - if the model instance is not found

evaluateExpressionInModel

EvaluationResult evaluateExpressionInModel(long modelId,
                                           String source,
                                           boolean fullExecutionModel)
                                    throws ValidationException,
                                           ErrorException

Parses the string to the expression and than evaluates it in the empty model context

Parameters:

modelId -

source -

fullExecutionModel -

Returns:

result of the expression evaluation

Throws:

ValidationException

ErrorException

LspsRuntimeException - if the model instance is not found

evaluateExpressions

List<EvaluationResult> evaluateExpressions(long modelInstanceId,
                                           List<String> sources,
                                           boolean fullExecutionModel)
                                    throws ValidationException,
                                           ErrorException

Parses the string sources of expressions in the list evaluates them end returns list of results.

Parameters:

modelInstanceId -

sources -

fullExecutionModel -

Returns:

list of results

Throws:

ValidationException

ErrorException

LspsRuntimeException - if the model instance is not found

getExecutionContext

ExecutionContext getExecutionContext(long modelInstanceId)

Returns an execution context for the given model instance id or null if it does not exist.

Parameters:

modelInstanceId -

Returns:

the execution context for the given model instance

Throws:

LspsRuntimeException - if the model instance is not found

getExecutionContext

ExecutionContext getExecutionContext(long modelInstanceId,
                                     long contextId)

Returns an execution context for the given context in the model instance or null if it does not exist.

Parameters:

modelInstanceId -

contextId -

Returns:

the execution context for the given model instance

Throws:

LspsRuntimeException - if the model instance is not found

getExecutionContext

ExecutionContext getExecutionContext(long modelInstanceId,
                                     long contextId,
                                     String level)

Returns an execution context for the given context in the model instance or null if it does not exist.

Parameters:

modelInstanceId -

contextId -

level -

Returns:

the execution context for the given model instance

Throws:

LspsRuntimeException - if the model instance is not found

getExecutionContext

ExecutionContext getExecutionContext(long modelId,
                                     ModelInstanceType modelInstanceType,
                                     String level)

Returns an execution context for the given model or null if it does not exist.

Parameters:

modelId -

modelInstanceType -

level -

Returns:

the execution context for the given model instance

Throws:

LspsRuntimeException - if the model instance is not found

getPersistentExecutionContext

ExecutionContext getPersistentExecutionContext(long modelId,
                                               ModelInstanceType type,
                                               String evaluationLevel)

Returns an execution context for the given model or null if it does not exist. The created model instance is stored in the database.

Parameters:

modelId -

type -

evaluationLevel -

Returns:

the execution context for the given model instance

allocateValueIds

AllocatedModelInstanceResources allocateValueIds(long modelInstanceId,
                                                 long allocatedSize)

Allocates new range of value ids.

Parameters:

modelInstanceId -

allocatedSize -

Returns:

new range of value ids

allocateDetachmentAndValueIds

AllocatedModelInstanceResources allocateDetachmentAndValueIds(long modelInstanceId,
                                                              long allocatedSize)

Allocates new range of value ids and detachment id.

Parameters:

modelInstanceId -

allocatedSize -

Returns:

new range of value ids and detachment id

getRecordTypeForEntity

RecordType getRecordTypeForEntity(Object object,
                                  long modelId)

Returns record type for entity.

Parameters:

object -

modelId -

Returns:

record type for entity

getCompatibilityVersion

CompatibilityVersion getCompatibilityVersion(long modelId)

Returns compatibility version for the module.

Parameters:

modelId -

Returns:

compatibility version for the module

getComponentService

ComponentService getComponentService()

Answer component service instance

Returns:

ComponentService