com.whitestein.lsps.engine

Interface ModelProvider

All Superinterfaces:

ComponentService

All Known Implementing Classes:

ModelProviderImpl

public interface ModelProvider
extends ComponentService

Provider of model elements.

Author:

bhl

Method Summary

Modifier and Type	Method and Description
CompatibilityVersion	getCompatibilityVersion(long modelId) Returns compatibility version for the module.
com.whitestein.lsps.model.ElementWithId	getModelElement(long modelId, com.whitestein.lsps.model.ElementType type, String elementId) Returns cached model element.
com.whitestein.lsps.model.ElementWithId	getModelElement(long modelId, String elementId, com.whitestein.lsps.model.ElementType... types) Returns model element with specified elementId and type from the specified model.
String	getModelHash(long modelId) Returns hash of the model.
long	getModelId(String hash) Returns id of the model under which the model is persisted.
com.whitestein.lsps.model.ProcessModel	getProcessModel(long id) Returns process model persisted under specified id.
com.whitestein.lsps.model.ProcessModel	getProcessModel(String hash) Returns process model with specified model runtime hash.
RecordType	getRecordTypeForEntity(Object object, long modelId) Returns record type for entity.
boolean	isActive(long modelId) Returns true if model is loaded and unloadDate is null.
RecordType	resolveRecordType(long moduleId, String qualifiedName) Resolves record by its qualified name in given model.
Type	resolveType(long modelId, String qualifiedName) Resolves type by its qualified name in given model.

Methods inherited from interface com.whitestein.lsps.common.ComponentService

getComponent, getComponent, getComponent, getComponents

Method Detail

getModelId

long getModelId(String hash)

Returns id of the model under which the model is persisted. Throws LspsRuntimeException if the model does not exist.

Parameters:

hash -

Returns:

id of the process model under which the model is persisted

getModelHash

String getModelHash(long modelId)

Returns hash of the model. Throws LspsRuntimeException if the model does not exist.

Parameters:

modelId -

Returns:

hash of the process model

isActive

boolean isActive(long modelId)

Returns true if model is loaded and unloadDate is null.

Parameters:

modelId -

Returns:

true if model is unloaded

getProcessModel

com.whitestein.lsps.model.ProcessModel getProcessModel(long id)

Returns process model persisted under specified id.

Parameters:

id -

Returns:

process model persisted under specified id

getProcessModel

com.whitestein.lsps.model.ProcessModel getProcessModel(String hash)

Returns process model with specified model runtime hash.

Parameters:

hash -

Returns:

process model with specified model runtime hash

getModelElement

com.whitestein.lsps.model.ElementWithId getModelElement(long modelId,
                                                        String elementId,
                                                        com.whitestein.lsps.model.ElementType... types)

Returns model element with specified elementId and type from the specified model.

Parameters:

modelId -

elementId -

types -

Returns:

model element with specified elementId and type from the specified model

getModelElement

com.whitestein.lsps.model.ElementWithId getModelElement(long modelId,
                                                        com.whitestein.lsps.model.ElementType type,
                                                        String elementId)

Returns cached model element.

Parameters:

modelId -

type -

elementId -

Returns:

model element

resolveType

Type resolveType(long modelId,
                 String qualifiedName)
          throws ValidationException

Resolves type by its qualified name in given model.

Parameters:

modelId -

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:

ValidationException - if model with given id does not exist

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