ModelInstance (LSPS 3.2 SDK)

java.lang.Object
- com.whitestein.lsps.engine.state.xml.ModelInstance

All Implemented Interfaces:

UnmarshalCallback, Collectible, ModelInstanceAware, XmlEntity

Direct Known Subclasses:

EmptyModelInstance
```
public class ModelInstance
extends Object
implements XmlEntity, Collectible, ModelInstanceAware
```
Entity representing a model instance state.

Author:

rba

Field Summary

Fields
Modifier and Type Field and Description

static String SCHEMA_NAMESPACE
ModelInstance schema namespace.

Fields
Modifier and Type	Field and Description
`static String`	`SCHEMA_NAMESPACE` ModelInstance schema namespace.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ModelInstance()` Creates new empty instance of `ModelInstance`.
	ModelInstance(long id, long modelId, Long modelInstanceMigrationId, String modelName, String modelVersion, String modelHash, CompatibilityVersion compatibilityVersion, boolean createProcessLog, Map<String,String> properties, Long parentId, ModelInstanceState state, ModelInstanceType type, Date startedDate, Date finishedDate, ModelInstanceResourceAllocator idAllocator, long maxAllocatedId, long currentId, long curentInternalVersion, Set<Context> topNoBaseLevelContexts, Long detachmentId, Long detachingTaskId, Set<String> evaluationLevelsOnDetach, Boolean isUsingEvaluationLevels) Creates new instance of `ModelInstance`.
	`ModelInstance(long id, long modelId, String modelName, String modelVersion, String modelHash, CompatibilityVersion compatibilityVersion, ModelInstanceType type, boolean createProcessLog, Long parentId, Map<String,String> properties, ModelInstanceResourceAllocator idAllocator)` Creates new instance of `ModelInstance`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChangeListener(ChangeListener listener)` Adds change listener.
`void`	`addChangeListeners(Collection<? extends ChangeListener> listeners)` Adds change listeners.
`void`	`addEntityHolder(Object entity, ExternalRecordHolder holder)` Adds entity - holder pair
`void`	`addEscalation(Escalation escalation)` Adds an escalation to this model instance.
`void`	`addExternalRecordListener(ExternalRecordListener listener)` Adds an external record listener.
`void`	`addLastPersisted(ExternalValue value)` Add to last persisted objects.
`ModuleInstance`	`addModuleInstance(ModuleInstance moduleInstance)` Adds a module to this model instance.
`ModuleInstance`	`addNewModuleInstance(Context context)` Adds new module instance.
`ModuleInstance`	`addNewModuleInstance(com.whitestein.lsps.model.ProcessModel processModel)` Adds new module instance.
`void`	`addProcessLog(ProcessLog log)` Adds a process log.
`void`	`addProperty(String name, String value)` Adds a property.
`void`	`addSignal(Signal signal)` Adds a signal.
`Signal`	`addSignal(Value val)` Adds a new signal.
`Signal`	`addSignal(Value val, String sourceDescritpion)` Adds a new signal.
`void`	`addTopNoBaseLevelContext(Context context)` adds top no-base level context
`void`	`addValue(ModelInstanceAware val)` Adds value.
`void`	`clearLoadedEntities()` Removes shared runtime values registered via `registerRuntimeValue(ComplexValue, Object)` method.
`void`	`clearRuntimeValues()` Clears all cached values inside runtime value objects.
`void`	`collect()` Removes itself from the process.
`void`	`collectGarbage()` Collects all `Collectible`s which are not persistent and are not directly or indirectly referenced from a persistent collectible.
`void`	`collectGarbageExclude(Collection<? extends Collectible> toRetain)` Collects all `Collectible`s which are not persistent and are not directly or indirectly referenced from a persistent collectible and are not in the toRetain collection.
`void`	`detach(long detachingTaskId, boolean isUsingEvaluationLevels)` Detach this model instance.
`ExternalValue`	`findCreateExternalValue(String typeString, String primaryKeyString, Long processInstanceId)` Finds an existing external value for the type and primary key.
`ExternalValue`	`findCreateExternalValue(String typeString, String primaryKeyString, Long processInstanceId, Long revisionId)` Finds an existing external value for the type and primary key.
`void`	`fireChange(Change change)` Fires a change.
`void`	`fireExternalRecordPropertyAccess(ExternalRecordPropertyAccessEvent event)` Fires an event that external record property was accessed.
`Collection<? extends EvaluationLevelAware>`	`getAllEntitiesInLevel(String level)` Returns all entities in a level.
`<T extends EvaluationLevelAware> Collection<T>`	`getAllEntitiesInLevel(String level, Class<T> entityClass)` Returns all entities of a given class in a given level.
`Collection<? extends EvaluationLevelAware>`	`getAllEntitiesInLevels(Collection<String> levels)` Returns all entities in given levels.
`Collection<EvaluationLevelAware>`	`getAllEvaluationLevelAwareEntities()` Returns all evaluation aware entities from this model instance.
`List<EvaluationLevelAware>`	`getAllLevelEntities(long baseLevelId)` Returns all entities that have same base evaluation level entity id.
`Collection<RecordValue>`	`getAllNotPersistedRecords(RecordType recordType, String level, boolean includeLowerLevels)` Returns all records of the type that exists in the evaluation level that are not persisted to the database.
`Object`	`getApplicationData(String key)` Returns application data.
`Long`	`getBaseLevelEntityIdforEntity(long entityId)` Returns id of the base level entity corresponding to the entity with the specified id.
`CompatibilityVersion`	`getCompatibilityVersion(ModelProviderClientService modelProviderService)` Returns compatibility version.
`CompiledContext`	`getCompiledContext(ModelProviderClientService modelProviderService, String moduleName, String evaluationLevel)`
`ComplexValue`	`getComplexValue(long id)` Returns complex value for given id.
`ComplexValue`	`getComplexValue(String level, long baseId)` Returns complex value for given level and baseValueId.
`Context`	`getContext(long id)` Returns context from this model instance for the given id.
`Context`	`getContext(String level, long baseId)` Returns context from this model instance for the given level and baseContextId.
`RuntimeToPersistentConverter`	`getConverter(ModelProviderClientService modelProviderService)` Lazily creates a runtime converter.
`long`	`getCurrentId()` Returns the current id.
`long`	`getCurrentInternalVersion()` Returns current internal version,
`Long`	`getCurrentInvocationTimestamp()` Returns current invocation timestamp
`ProcessInstance`	`getCurrentProcessInstance()` Gets current process instance.
`Token`	`getCurrentToken()` Gets currently handled token.
`Long`	`getDetachingTaskId()` Returns id of a task for which the detached model instance is created.
`Long`	`getDetachmentId()` Returns the last allocated detachment id.
`String`	`getDocumentDescription()` Gets a description of a document or `null` if no document description has been set for this model instance.
`<T extends EntityWithId> Collection<T>`	`getEntities(Class<T> entityClass)` Returns a collection of all registered entities for the specified type.
`EntityWithId`	`getEntity(long id)` Returns an entity for the specified id.
`<T extends EntityWithId> T`	`getEntity(long id, Class<T> entityClass)` Returns an entity for the specified id and entity class.
`List<Escalation>`	`getEscalations()` Returns a new list which holds all escalations in the model instance.
`Set<String>`	`getEvaluationLevels()` Returns all current evaluation levels.
`Set<String>`	`getEvaluationLevelsOnDetach()` Set of used evaluation levels at the moment of detachment.
`List<ExternalRecordListener>`	`getExternalRecordListeners()` Returns an unmodifiable list of external record listeners.
`Map<String,ExternalValue>`	`getExternalValues()` Returns map of entity identification -> external value
`Date`	`getFinishedDate()` Returns the finished date.
`ExternalRecordHolder`	`getHolderForEntity(Object entity)` Returns holder for an entity.
`Long`	`getId()` Returns the id.
`ModelInstanceResourceAllocator`	`getIdAllocator()` Returns value id allocator.
`long`	`getInitialInternalVersionFor(String level)` Returns initial internal version to be used.
`List<ExternalValue>`	`getLastPersisted()` Returns records persisted during last evaluation level merge.
`List<ProcessLog>`	`getLogs()` Returns list of process logs.
`ModuleInstance`	`getMainModuleInstance()` Returns the main module (the first module).
`long`	`getMaxAllocatedId()` Returns maximal allocated id.
`String`	`getModelHash()` Returns the model hash.
`long`	`getModelId()` Returns the model id.
`ModelInstance`	`getModelInstance()` Returns the model instance.
`Long`	`getModelInstanceMigrationId()` Returns the model instance migration id.
`String`	`getModelName()` Returns the model name.
`String`	`getModelVersion()` Returns the model version.
`ModuleInstance`	`getModuleInstance(String name)` Returns module from this model instance for the given name.
`Collection<ModuleInstance>`	`getModuleInstances()` Returns all modules in this model instance.
`Long`	`getParentId()` Returns the parent id.
`ProcessInstance`	`getProcessInstance(long id)` Returns process instance from this model instance for the given id.
`Collection<ProcessInstance>`	`getProcessInstances()` Returns a collection of all registered process instances.
`Map<String,String>`	`getProperties()` Returns the properties
`String`	`getProperty(String name)` Returns value of the property.
`Collection<Collectible>`	`getReferences()` Returns collection of all referenced collectible objects.
`Object`	`getRuntimeValue(Value value)`
`Map<ComplexValue,Object>`	`getRuntimeValues()` Returns map of runtime values.
`Signal`	`getSignal(long id)` Returns signal from this model instance for the given id.
`Collection<Signal>`	`getSignals()` Returns the signals as an unmodifiable view.
`Date`	`getStartedDate()` Returns the started date.
`ModelInstanceState`	`getState()` Returns life-cycle state.
`Task`	`getTask(long id)` Returns task from this model instance for the given id.
`Collection<Task>`	`getTasks()` Returns a collection of all model instance tasks.
`List<ExternalRecordHolder>`	`getToBeRemoved()` Auxiliary collections used for deleting records.
`Set<Context>`	`getTopNoBaseLevelContexts()` Returns top contexts from evaluation levels higher that base level.
`ModelInstanceType`	`getType()` Returns model instance type.
`Collection<ComplexValue>`	`getValues()` Returns the model instance complex values.
`boolean`	`isCanClearRuntimeValues()` Returns true if cleaning of runtime values is on.
`boolean`	`isCreateProcessLog()`
`boolean`	`isDetached()` Returns true if the model instance is detached.
`boolean`	`isDirty()` Returns true if the model instance is dirty.
`boolean`	`isDocument()` Returns true if the model instance stores state of document.
`boolean`	`isEvaluation()` Returns true if the model instance is used for expression evaluation.
`boolean`	`isFinished()` Returns true if the model instance is finished.
`boolean`	`isFormPreview()` Returns true if the model instance stores state of form preview.
`boolean`	`isMonitoringChanged()`
`boolean`	`isPersistent()` Returns true if this object cannot be collected.
`boolean`	`isProcess()` Returns true if the model instance stores state of execution of processes.
`boolean`	`isTrackingDirty()` Returns true if tracking of dirtiness is switched on.
`boolean`	`isTrackingVersions()` Returns true if versions of shared entities are tracked so what optimistic locking can be chacked.
`boolean`	`isUsingEvaluationLevels()` Returns true is a detached model instance is using evaluation levels.
`ModelInstance`	`makeCopy()` Returns deep copy of the model instance.
`long`	`nextId()` Returns next id and increments the id counter.
`long`	`nextInternalVersion()` Returns next internal version value.
`void`	`postUnmarshal(javax.xml.bind.Unmarshaller unmarshaller, Object parent)` Callback method invoked after unmarshalling XML data into `target`.
`void`	`preUnmarshal(javax.xml.bind.Unmarshaller unmarshaller, Object parent)` Callback method invoked before unmarshalling into `target`.
`void`	`rebind(ModelInstance modelInstance)` Re-bind to the provided model instance.
`void`	`registerRuntimeValue(ComplexValue value, Object runtimeValue)` Creates mapping between given value (xml representation of object in process context) and actual runtime value, so that the runtime value doesn't need to be created again.
`boolean`	`removeChangeListener(ChangeListener listener)` Removes change listener.
`void`	`removeChangeListeners()` Removes all change listeners.
`<T extends ChangeListener> Set<T>`	`removeChangeListeners(Class<T> listenerClass)` Remove all listeners of specified class.
`void`	`removeEntityHolder(Object entity)` Removes entity -holder pair
`void`	`removeEscalation(Escalation escalation)` Removes the escalation from this model instance.
`void`	`removeExternalRecordListener(ExternalRecordListener listener)` Removes an external record listener.
`ModuleInstance`	`removeModuleInstance(String name)` Removes a module instance.
`void`	`removeRuntimeValues()` Removes all runtime values registered via `registerRuntimeValue(ComplexValue, Object)` method.
`void`	`removeSignal(Signal item)` Removes the given signal item.
`void`	`removeValue(ModelInstanceAware val)` Removes value.
`void`	`resetLastPersisted()` Resets last persisted.
`void`	`setApplicationData(String key, Object value)` Sets application data.
`void`	`setCanClearRuntimeValues(boolean canClearRuntimeValues)` Sets on/off cleaning of runtime values.
`void`	`setCreateProcessLog(boolean createProcessLog)`
`void`	`setCurrentInternalVersion(long internalVersion)` Sets current internal value.
`void`	`setCurrentProcessInstance(ProcessInstance currentProcessInstance)` Sets current process instance.
`void`	`setCurrentToken(Token currentToken)` Sets currently handled token.
`void`	`setDirty(boolean isDirty)` Sets isDirty.
`void`	`setDocumentDescription(String documentDescription)` Sets the description of a document for this model instance.
`void`	`setFinishedDate(Date finishedDate)` Sets the finished date.
`void`	`setId(Long id)` Sets the id.
`void`	`setIdAllocator(ModelInstanceResourceAllocator idAllocator)` Sets allocator.
`void`	`setIsMonitoringChange(boolean value)`
`void`	`setIsTrackingVersions(boolean isTracking)` Sets tracking of the shared entities version to the provided value, and cleans version string of all shared values and sets renewVersion of all shared values to the provided value.
`void`	`setModelHash(String modelHash)` Sets the model hash.
`void`	`setModelId(long modelId)` Sets the model id.
`void`	`setModelInstanceMigrationId(Long modelInstanceMigrationId)` Sets the model instance migration id.
`void`	`setModelName(String modelName)` Sets the model name.
`void`	`setModelVersion(String modelVersion)` Sets the model version.
`void`	`setStartedDate(Date startedDate)` Sets the started date.
`void`	`setState(ModelInstanceState state)` Sets life-cycle state.
`void`	`setTrackingDirty(boolean isTrackingDirty)` Switch on/off checking of dirtiness.
`void`	`synchronizeIdSeq(ModelInstance modelInstance)` Synchronize value id counter and max allocated value id.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SCHEMA_NAMESPACE
```
public static final String SCHEMA_NAMESPACE
```
    ModelInstance schema namespace.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ModelInstance
```
protected ModelInstance()
```
    Creates new empty instance of ModelInstance.
  - ModelInstance
```
public ModelInstance(long id,
                     long modelId,
                     String modelName,
                     String modelVersion,
                     String modelHash,
                     CompatibilityVersion compatibilityVersion,
                     ModelInstanceType type,
                     boolean createProcessLog,
                     Long parentId,
                     Map<String,String> properties,
                     ModelInstanceResourceAllocator idAllocator)
```
    Creates new instance of ModelInstance.
    
    Parameters:
    
    id -
    
    modelId -
    
    modelName -
    
    modelVersion -
    
    modelHash -
    
    compatibilityVersion -
    
    type -
    
    createProcessLog -
    
    parentId -
    
    properties -
    
    idAllocator -
    
    Throws:
    
    NullPointerException - if agentName is null
  - ModelInstance
```
public ModelInstance(long id,
                     long modelId,
                     Long modelInstanceMigrationId,
                     String modelName,
                     String modelVersion,
                     String modelHash,
                     CompatibilityVersion compatibilityVersion,
                     boolean createProcessLog,
                     Map<String,String> properties,
                     Long parentId,
                     ModelInstanceState state,
                     ModelInstanceType type,
                     Date startedDate,
                     Date finishedDate,
                     ModelInstanceResourceAllocator idAllocator,
                     long maxAllocatedId,
                     long currentId,
                     long curentInternalVersion,
                     Set<Context> topNoBaseLevelContexts,
                     Long detachmentId,
                     Long detachingTaskId,
                     Set<String> evaluationLevelsOnDetach,
                     Boolean isUsingEvaluationLevels)
```
    Creates new instance of ModelInstance.
    
    Parameters:
    
    id -
    
    modelId -
    
    modelInstanceMigrationId -
    
    modelName -
    
    modelVersion -
    
    modelHash -
    
    compatibilityVersion -
    
    createProcessLog -
    
    properties -
    
    parentId -
    
    state -
    
    type -
    
    startedDate -
    
    finishedDate -
    
    idAllocator -
    
    maxAllocatedId -
    
    currentId -
    
    curentInternalVersion -
    
    topNoBaseLevelContexts -
    
    detachmentId -
    
    detachingTaskId - the identifier of a task for which the model instance was detached
    
    isUsingEvaluationLevels -
    
    evaluationLevelsOnDetach -
    
    Throws:
    
    NullPointerException - if agentName is null
- Method Detail
  - getId
```
public Long getId()
```
    Returns the id.
    
    Returns:
    
    the id
  - setId
```
public void setId(Long id)
```
    Sets the id.
    
    Parameters:
    
    id -
  - getModelId
```
public long getModelId()
```
    Returns the model id.
    
    Returns:
    
    the model id
  - setModelId
```
public void setModelId(long modelId)
```
    Sets the model id.
    
    Parameters:
    
    modelId -
  - getModelInstanceMigrationId
```
public Long getModelInstanceMigrationId()
```
    Returns the model instance migration id.
    
    Returns:
    
    the model instance migration id
  - setModelInstanceMigrationId
```
public void setModelInstanceMigrationId(Long modelInstanceMigrationId)
```
    Sets the model instance migration id.
    
    Parameters:
    
    modelInstanceMigrationId -
  - getModelName
```
public String getModelName()
```
    Returns the model name.
    
    Returns:
    
    the model name
  - setModelName
```
public void setModelName(String modelName)
```
    Sets the model name.
    
    Parameters:
    
    modelName -
  - getModelVersion
```
public String getModelVersion()
```
    Returns the model version.
    
    Returns:
    
    the model version
  - setModelVersion
```
public void setModelVersion(String modelVersion)
```
    Sets the model version.
    
    Parameters:
    
    modelVersion -
  - getModelHash
```
public String getModelHash()
```
    Returns the model hash.
    
    Returns:
    
    the model hash
  - setModelHash
```
public void setModelHash(String modelHash)
```
    Sets the model hash.
    
    Parameters:
    
    modelHash -
  - isCreateProcessLog
```
public boolean isCreateProcessLog()
```
    Returns:
    
    the createProcessLog
  - setCreateProcessLog
```
public void setCreateProcessLog(boolean createProcessLog)
```
    Parameters:
    
    createProcessLog - the createProcessLog to set
  - getProperties
```
public Map<String,String> getProperties()
```
    Returns the properties
    
    Returns:
    
    properties
  - getProperty
```
public String getProperty(String name)
```
    Returns value of the property.
    
    Parameters:
    
    name -
    
    Returns:
    
    value of the property
  - getState
```
public ModelInstanceState getState()
```
    Returns life-cycle state.
    
    Returns:
    
    life-cycle state
  - setState
```
public void setState(ModelInstanceState state)
```
    Sets life-cycle state.
    
    Parameters:
    
    state -
  - getType
```
public ModelInstanceType getType()
```
    Returns model instance type.
    
    Returns:
    
    model instance type
  - isProcess
```
public boolean isProcess()
```
    Returns true if the model instance stores state of execution of processes.
    
    Returns:
    
    true if the model instance stores state of execution of processes.
  - isDocument
```
public boolean isDocument()
```
    Returns true if the model instance stores state of document.
    
    Returns:
    
    true if the model instance stores state of document.
  - isFormPreview
```
public boolean isFormPreview()
```
    Returns true if the model instance stores state of form preview.
    
    Returns:
    
    true if the model instance stores state of form preview.
  - isEvaluation
```
public boolean isEvaluation()
```
    Returns true if the model instance is used for expression evaluation.
    
    Returns:
    
    true if the model instance is used for expression evaluation.
  - isFinished
```
public boolean isFinished()
```
    Returns true if the model instance is finished.
    
    Returns:
    
    true if the model instance is finished
  - isDetached
```
public boolean isDetached()
```
    Returns true if the model instance is detached.
    
    Returns:
    
    true if the model instance is detached
  - getStartedDate
```
public Date getStartedDate()
```
    Returns the started date.
    
    Returns:
    
    the started date
  - getFinishedDate
```
public Date getFinishedDate()
```
    Returns the finished date.
    
    Returns:
    
    the finished date
  - setStartedDate
```
public void setStartedDate(Date startedDate)
```
    Sets the started date.
    
    Parameters:
    
    startedDate -
  - setFinishedDate
```
public void setFinishedDate(Date finishedDate)
```
    Sets the finished date.
    
    Parameters:
    
    finishedDate -
  - getSignals
```
public Collection<Signal> getSignals()
```
    Returns the signals as an unmodifiable view.
    
    Returns:
    
    the signals as an unmodifiable view
  - addSignal
```
public Signal addSignal(Value val)
```
    Adds a new signal.
    
    Parameters:
    
    val -
    
    Returns:
    
    new signal
    
    Throws:
    
    NullPointerException - if val is null
  - addSignal
```
public Signal addSignal(Value val,
                        String sourceDescritpion)
```
    Adds a new signal.
    
    Parameters:
    
    val -
    
    sourceDescritpion - the description of the source of the signal
    
    Returns:
    
    new signal
    
    Throws:
    
    NullPointerException - if val is null
  - addSignal
```
public void addSignal(Signal signal)
```
    Adds a signal.
    
    Parameters:
    
    signal -
  - removeSignal
```
public void removeSignal(Signal item)
```
    Removes the given signal item.
    
    Parameters:
    
    item -
  - addEscalation
```
public void addEscalation(Escalation escalation)
```
    Adds an escalation to this model instance. The added escalation should be created for a process instance which belongs to this model instance.
    
    Parameters:
    
    escalation - the escalation to be added
  - removeEscalation
```
public void removeEscalation(Escalation escalation)
```
    Removes the escalation from this model instance.
    
    Parameters:
    
    escalation - the escalation to be removed
  - getEscalations
```
public List<Escalation> getEscalations()
```
    Returns a new list which holds all escalations in the model instance.
    
    Returns:
    
    the escalations in a new list
  - getIdAllocator
```
public ModelInstanceResourceAllocator getIdAllocator()
```
    Returns value id allocator.
    
    Returns:
    
    value id allocator
  - setIdAllocator
```
public void setIdAllocator(ModelInstanceResourceAllocator idAllocator)
```
    Sets allocator.
    
    Parameters:
    
    idAllocator -
  - getDetachmentId
```
public Long getDetachmentId()
```
    Returns the last allocated detachment id.
    
    Returns:
    
    the last allocated detachment id
  - getDetachingTaskId
```
public Long getDetachingTaskId()
```
    Returns id of a task for which the detached model instance is created.
    
    Returns:
    
    id of a task for which the detached model instance is created
  - isUsingEvaluationLevels
```
public boolean isUsingEvaluationLevels()
```
    Returns true is a detached model instance is using evaluation levels. For non-detached model instance this value is not relevant and it always returns false.
    
    Returns:
    
    true is a detached model instance is using evaluation levels
  - getMaxAllocatedId
```
public long getMaxAllocatedId()
```
    Returns maximal allocated id.
    
    Returns:
    
    maximal allocated id
  - synchronizeIdSeq
```
public void synchronizeIdSeq(ModelInstance modelInstance)
```
    Synchronize value id counter and max allocated value id. Max values are set in both model instances.
    
    Parameters:
    
    modelInstance -
  - getCurrentId
```
public long getCurrentId()
```
    Returns the current id.
    
    Returns:
    
    the current id
  - nextId
```
public long nextId()
```
    Returns next id and increments the id counter.
    
    Returns:
    
    next id
  - getCurrentInternalVersion
```
public long getCurrentInternalVersion()
```
    Returns current internal version,
    
    Returns:
    
    current internal version
  - setCurrentInternalVersion
```
public void setCurrentInternalVersion(long internalVersion)
```
    Sets current internal value.
    
    Parameters:
    
    internalVersion -
  - nextInternalVersion
```
public long nextInternalVersion()
```
    Returns next internal version value.
    
    Returns:
    
    next internal version value
  - getInitialInternalVersionFor
```
public long getInitialInternalVersionFor(String level)
```
    Returns initial internal version to be used.
    
    Parameters:
    
    level -
    
    Returns:
    
    initial internal version to be used
  - getParentId
```
public Long getParentId()
```
    Returns the parent id.
    
    Returns:
    
    parent id
  - getComplexValue
```
public ComplexValue getComplexValue(long id)
```
    Returns complex value for given id.
    
    Parameters:
    
    id -
    
    Returns:
    
    complex value for given id
  - getComplexValue
```
public ComplexValue getComplexValue(String level,
                                    long baseId)
```
    Returns complex value for given level and baseValueId.
    
    Parameters:
    
    level -
    
    baseId -
    
    Returns:
    
    complex value for given level and baseValueId
  - addChangeListener
```
public void addChangeListener(ChangeListener listener)
```
    Adds change listener.
    
    Parameters:
    
    listener -
  - addChangeListeners
```
public void addChangeListeners(Collection<? extends ChangeListener> listeners)
```
    Adds change listeners.
    
    Parameters:
    
    listeners -
  - removeChangeListener
```
public boolean removeChangeListener(ChangeListener listener)
```
    Removes change listener.
    
    Parameters:
    
    listener -
    
    Returns:
    
    true if the model instance contained given listener
  - removeChangeListeners
```
public <T extends ChangeListener> Set<T> removeChangeListeners(Class<T> listenerClass)
```
    Remove all listeners of specified class. Returns removed listeners.
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    listenerClass -
    
    Returns:
    
    removed listeners
  - removeChangeListeners
```
public void removeChangeListeners()
```
    Removes all change listeners.
  - fireChange
```
public void fireChange(Change change)
```
    Fires a change.
    
    Parameters:
    
    change -
  - addExternalRecordListener
```
public void addExternalRecordListener(ExternalRecordListener listener)
```
    Adds an external record listener.
    
    Parameters:
    
    listener -
  - removeExternalRecordListener
```
public void removeExternalRecordListener(ExternalRecordListener listener)
```
    Removes an external record listener.
    
    Parameters:
    
    listener -
  - fireExternalRecordPropertyAccess
```
public void fireExternalRecordPropertyAccess(ExternalRecordPropertyAccessEvent event)
```
    Fires an event that external record property was accessed.
    
    Parameters:
    
    event -
  - getExternalRecordListeners
```
public List<ExternalRecordListener> getExternalRecordListeners()
```
    Returns an unmodifiable list of external record listeners.
    
    Returns:
    
    an unmodifiable list of external record listeners
  - getModelInstance
```
public ModelInstance getModelInstance()
```
    Description copied from interface: ModelInstanceAware
    
    Returns the model instance.
    
    Specified by:
    
    getModelInstance in interface ModelInstanceAware
    
    Returns:
    
    the model instance
  - rebind
```
public void rebind(ModelInstance modelInstance)
```
    Description copied from interface: ModelInstanceAware
    
    Re-bind to the provided model instance.
    
    Specified by:
    
    rebind in interface ModelInstanceAware
  - getContext
```
public Context getContext(long id)
```
    Returns context from this model instance for the given id.
    
    Parameters:
    
    id -
    
    Returns:
    
    context from this model instance for the given id
  - getContext
```
public Context getContext(String level,
                          long baseId)
```
    Returns context from this model instance for the given level and baseContextId.
    
    Parameters:
    
    level -
    
    baseId -
    
    Returns:
    
    context from this model instance for the given level and baseContextId
  - getAllLevelEntities
```
public List<EvaluationLevelAware> getAllLevelEntities(long baseLevelId)
```
    Returns all entities that have same base evaluation level entity id. It means it returns all representations of the same entity in all existing evaluation levels.
    
    Parameters:
    
    baseLevelId -
    
    Returns:
    
    all representations of the same entity in all existing evaluation levels
  - getProcessInstance
```
public ProcessInstance getProcessInstance(long id)
```
    Returns process instance from this model instance for the given id.
    
    Parameters:
    
    id -
    
    Returns:
    
    process instance from this model instance for the given id
  - getEntity
```
public <T extends EntityWithId> T getEntity(long id,
                                            Class<T> entityClass)
```
    Returns an entity for the specified id and entity class.
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    id -
    
    entityClass -
    
    Returns:
    
    an entity for the specified id and entity class
  - getEntity
```
public EntityWithId getEntity(long id)
```
    Returns an entity for the specified id.
    
    Parameters:
    
    id -
    
    Returns:
    
    an entity for the specified id and entity class
  - getProcessInstances
```
public Collection<ProcessInstance> getProcessInstances()
```
    Returns a collection of all registered process instances.
    
    Returns:
    
    a collection of all registered process instances
  - getEntities
```
public <T extends EntityWithId> Collection<T> getEntities(Class<T> entityClass)
```
    Returns a collection of all registered entities for the specified type.
    
    Type Parameters:
    
    T -
    
    Parameters:
    
    entityClass -
    
    Returns:
    
    a collection of all registered entities for the specified type
  - getSignal
```
public Signal getSignal(long id)
```
    Returns signal from this model instance for the given id.
    
    Parameters:
    
    id -
    
    Returns:
    
    signal from this model instance for the given id
  - getTask
```
public Task getTask(long id)
```
    Returns task from this model instance for the given id.
    
    Parameters:
    
    id -
    
    Returns:
    
    task from this model instance for the given id
  - getTasks
```
public Collection<Task> getTasks()
```
    Returns a collection of all model instance tasks.
    
    Returns:
    
    a collection of all model instance tasks
  - getAllEntitiesInLevel
```
public Collection<? extends EvaluationLevelAware> getAllEntitiesInLevel(String level)
```
    Returns all entities in a level.
    Returned collection is a copy and is no more modified by calls to register(ModelInstanceAware) or unregister(ModelInstanceAware).
    
    Parameters:
    
    level -
    
    Returns:
    
    all entities in a level
  - getAllEntitiesInLevel
```
public <T extends EvaluationLevelAware> Collection<T> getAllEntitiesInLevel(String level,
                                                                            Class<T> entityClass)
```
    Returns all entities of a given class in a given level.
    Returned collection is a copy and is no more modified by calls to register(ModelInstanceAware) or unregister(ModelInstanceAware).
    
    Type Parameters:
    
    T - a class type
    
    Parameters:
    
    level -
    
    entityClass -
    
    Returns:
    
    all entities in a level
  - getAllEntitiesInLevels
```
public Collection<? extends EvaluationLevelAware> getAllEntitiesInLevels(Collection<String> levels)
```
    Returns all entities in given levels.
    Returned collection is a copy and is no more modified by calls to register(ModelInstanceAware) or unregister(ModelInstanceAware).
    
    Parameters:
    
    levels -
    
    Returns:
    
    all entities in given levels
  - getAllEvaluationLevelAwareEntities
```
public Collection<EvaluationLevelAware> getAllEvaluationLevelAwareEntities()
```
    Returns all evaluation aware entities from this model instance.
    
    Returns:
    
    all evaluation aware entities from this model instance
  - addValue
```
public void addValue(ModelInstanceAware val)
```
    Adds value.
    
    Parameters:
    
    val -
  - removeValue
```
public void removeValue(ModelInstanceAware val)
```
    Removes value.
    
    Parameters:
    
    val -
  - getValues
```
public Collection<ComplexValue> getValues()
```
    Returns the model instance complex values.
    
    Returns:
    
    the model instance complex values
  - getModuleInstance
```
public ModuleInstance getModuleInstance(String name)
```
    Returns module from this model instance for the given name.
    
    Parameters:
    
    name -
    
    Returns:
    
    module from this model instance for the given name
  - getModuleInstances
```
public Collection<ModuleInstance> getModuleInstances()
```
    Returns all modules in this model instance.
    
    Returns:
    
    all modules in this model instance
  - getMainModuleInstance
```
public ModuleInstance getMainModuleInstance()
```
    Returns the main module (the first module).
    
    Returns:
    
    the main module
  - removeModuleInstance
```
public ModuleInstance removeModuleInstance(String name)
```
    Removes a module instance.
    
    Parameters:
    
    name -
    
    Returns:
    
    the removed module instance
  - addModuleInstance
```
public ModuleInstance addModuleInstance(ModuleInstance moduleInstance)
```
    Adds a module to this model instance.
    
    Parameters:
    
    moduleInstance -
    
    Returns:
    
    added module instance
  - addNewModuleInstance
```
public ModuleInstance addNewModuleInstance(com.whitestein.lsps.model.ProcessModel processModel)
```
    Adds new module instance.
    
    Parameters:
    
    processModel -
    
    Returns:
    
    new module instance
    
    Throws:
    
    NullPointerException - if processModel is null
  - addNewModuleInstance
```
public ModuleInstance addNewModuleInstance(Context context)
```
    Adds new module instance.
    
    Parameters:
    
    context -
    
    Returns:
    
    new module instance
    
    Throws:
    
    NullPointerException - if context is null
  - addProcessLog
```
public void addProcessLog(ProcessLog log)
```
    Adds a process log.
    
    Parameters:
    
    log -
  - getLogs
```
public List<ProcessLog> getLogs()
```
    Returns list of process logs.
    
    Returns:
    
    list of process logs
  - getTopNoBaseLevelContexts
```
public Set<Context> getTopNoBaseLevelContexts()
```
    Returns top contexts from evaluation levels higher that base level.
    
    Returns:
    
    top contexts from evaluation levels higher that base level
  - addTopNoBaseLevelContext
```
public void addTopNoBaseLevelContext(Context context)
```
    adds top no-base level context
    
    Parameters:
    
    context -
  - getEvaluationLevelsOnDetach
```
public Set<String> getEvaluationLevelsOnDetach()
```
    Set of used evaluation levels at the moment of detachment.
    
    Returns:
    
    set of used evaluation levels at the moment of detachment
  - getEvaluationLevels
```
public Set<String> getEvaluationLevels()
```
    Returns all current evaluation levels.
    
    Returns:
    
    all current evaluation levels
  - detach
```
public void detach(long detachingTaskId,
                   boolean isUsingEvaluationLevels)
```
    Detach this model instance.
    
    Parameters:
    
    detachingTaskId - the id of a task for which the model instance id detached
    
    isUsingEvaluationLevels -
  - preUnmarshal
```
public void preUnmarshal(javax.xml.bind.Unmarshaller unmarshaller,
                         Object parent)
```
    Description copied from interface: UnmarshalCallback
    
    Callback method invoked before unmarshalling into target.
    
    This method is invoked immediately after target was created and before the unmarshalling of this object begins.
    
    Specified by:
    
    preUnmarshal in interface UnmarshalCallback
    
    parent - instance of JAXB mapped class that will eventually reference target. null when target is root element.
  - postUnmarshal
```
public void postUnmarshal(javax.xml.bind.Unmarshaller unmarshaller,
                          Object parent)
```
    Description copied from interface: UnmarshalCallback
    
    Callback method invoked after unmarshalling XML data into target.
    
    This method is invoked after all the properties (except IDREF) are unmarshalled into target, but before target is set into its parent object.
    
    Specified by:
    
    postUnmarshal in interface UnmarshalCallback
    
    parent - instance of JAXB mapped class that will reference target. null when target is root element.
  - collectGarbage
```
public void collectGarbage()
```
    Collects all Collectibles which are not persistent and are not directly or indirectly referenced from a persistent collectible. If the context is going to be committed, versions of external values are updated so that the references are up to date.
  - collectGarbageExclude
```
public void collectGarbageExclude(Collection<? extends Collectible> toRetain)
```
    Collects all Collectibles which are not persistent and are not directly or indirectly referenced from a persistent collectible and are not in the toRetain collection. If the context is going to be committed, versions of external values are updated so that the references are up to date.
    
    Parameters:
    
    toRetain -
  - isPersistent
```
public boolean isPersistent()
```
    Description copied from interface: Collectible
    
    Returns true if this object cannot be collected.
    
    Specified by:
    
    isPersistent in interface Collectible
    
    Returns:
    
    collected
  - getReferences
```
public Collection<Collectible> getReferences()
```
    Description copied from interface: Collectible
    
    Returns collection of all referenced collectible objects.
    
    Specified by:
    
    getReferences in interface Collectible
    
    Returns:
    
    collection of all referenced collectible objects
  - collect
```
public void collect()
```
    Description copied from interface: Collectible
    
    Removes itself from the process. This method is called only when the element is not persistence and is not referenced directly or indirectly from any other persistence element.
    
    Specified by:
    
    collect in interface Collectible
  - addProperty
```
public void addProperty(String name,
                        String value)
```
    Adds a property. Can overwrite existing properties.
    
    Parameters:
    
    name -
    
    value -
  - registerRuntimeValue
```
public void registerRuntimeValue(ComplexValue value,
                                 Object runtimeValue)
```
    Creates mapping between given value (xml representation of object in process context) and actual runtime value, so that the runtime value doesn't need to be created again.
    
    Parameters:
    
    value -
    
    runtimeValue -
  - getRuntimeValues
```
public Map<ComplexValue,Object> getRuntimeValues()
```
    Returns map of runtime values.
    
    Returns:
    
    map of runtime values
  - clearRuntimeValues
```
public void clearRuntimeValues()
```
    Clears all cached values inside runtime value objects.
  - removeRuntimeValues
```
public void removeRuntimeValues()
```
    Removes all runtime values registered via registerRuntimeValue(ComplexValue, Object) method.
  - setCanClearRuntimeValues
```
public void setCanClearRuntimeValues(boolean canClearRuntimeValues)
```
    Sets on/off cleaning of runtime values. Used for optimization of performance.
    
    Parameters:
    
    canClearRuntimeValues -
  - isCanClearRuntimeValues
```
public boolean isCanClearRuntimeValues()
```
    Returns true if cleaning of runtime values is on.
    
    Returns:
    
    true if cleaning of runtime values is on
  - clearLoadedEntities
```
public void clearLoadedEntities()
```
    Removes shared runtime values registered via registerRuntimeValue(ComplexValue, Object) method.
  - getRuntimeValue
```
public Object getRuntimeValue(Value value)
```
    Parameters:
    
    value -
    
    Returns:
    
    runtime value for given value, if it was registered by calling registerRuntimeValue(ComplexValue, Object) before, null otherwise.
  - getExternalValues
```
public Map<String,ExternalValue> getExternalValues()
```
    Returns map of entity identification -> external value
    
    Returns:
    
    external entities
  - findCreateExternalValue
```
public ExternalValue findCreateExternalValue(String typeString,
                                             String primaryKeyString,
                                             Long processInstanceId)
```
    Finds an existing external value for the type and primary key.
    
    Parameters:
    
    typeString -
    
    primaryKeyString -
    
    processInstanceId -
    
    Returns:
    
    an external value
  - findCreateExternalValue
```
public ExternalValue findCreateExternalValue(String typeString,
                                             String primaryKeyString,
                                             Long processInstanceId,
                                             Long revisionId)
```
    Finds an existing external value for the type and primary key.
    
    Parameters:
    
    typeString -
    
    primaryKeyString -
    
    processInstanceId -
    
    revisionId -
    
    Returns:
    
    an external value
  - getBaseLevelEntityIdforEntity
```
public Long getBaseLevelEntityIdforEntity(long entityId)
```
    Returns id of the base level entity corresponding to the entity with the specified id.
    
    Parameters:
    
    entityId -
    
    Returns:
    
    id of the base level entity corresponding to the entity with the specified id
  - getApplicationData
```
public Object getApplicationData(String key)
```
    Returns application data.
    
    Parameters:
    
    key -
    
    Returns:
    
    application data
  - setApplicationData
```
public void setApplicationData(String key,
                               Object value)
```
    Sets application data.
    
    Parameters:
    
    key -
    
    value -
  - isTrackingVersions
```
public boolean isTrackingVersions()
```
    Returns true if versions of shared entities are tracked so what optimistic locking can be chacked.
    
    Returns:
    
    true if versions of shared entities are tracked
  - setIsTrackingVersions
```
public void setIsTrackingVersions(boolean isTracking)
```
    Sets tracking of the shared entities version to the provided value, and cleans version string of all shared values and sets renewVersion of all shared values to the provided value. Tracking of versions is used for optimistic locking.
    
    Parameters:
    
    isTracking -
  - isDirty
```
public boolean isDirty()
```
    Returns true if the model instance is dirty.
    
    Returns:
    
    true if the model instance is dirty
  - setDirty
```
public void setDirty(boolean isDirty)
```
    Sets isDirty.
    
    Parameters:
    
    isDirty -
  - isTrackingDirty
```
public boolean isTrackingDirty()
```
    Returns true if tracking of dirtiness is switched on.
    
    Returns:
    
    true if tracking of dirtiness is switched on
  - setTrackingDirty
```
public void setTrackingDirty(boolean isTrackingDirty)
```
    Switch on/off checking of dirtiness.
    
    Parameters:
    
    isTrackingDirty -
  - getDocumentDescription
```
public String getDocumentDescription()
```
    Gets a description of a document or null if no document description has been set for this model instance.
    
    Returns:
    
    a document description of this model instance.
  - setDocumentDescription
```
public void setDocumentDescription(String documentDescription)
```
    Sets the description of a document for this model instance.
    
    Parameters:
    
    documentDescription - the document description
  - makeCopy
```
public ModelInstance makeCopy()
```
    Returns deep copy of the model instance.
    
    Returns:
    
    deep copy of the model instance
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getConverter
```
public RuntimeToPersistentConverter getConverter(ModelProviderClientService modelProviderService)
```
    Lazily creates a runtime converter.
    
    Parameters:
    
    modelProviderService -
    
    Returns:
    
    a runtime converter
  - getToBeRemoved
```
public List<ExternalRecordHolder> getToBeRemoved()
```
    Auxiliary collections used for deleting records.
    
    Returns:
    
    list of records that are to be deleted.
  - getAllNotPersistedRecords
```
public Collection<RecordValue> getAllNotPersistedRecords(RecordType recordType,
                                                         String level,
                                                         boolean includeLowerLevels)
```
    Returns all records of the type that exists in the evaluation level that are not persisted to the database. If includeLowerLevels is true the result is calculated for this and all lower levels.
    
    Parameters:
    
    recordType -
    
    level -
    
    includeLowerLevels -
    
    Returns:
    
    all records of the type that exists in the evaluation level that are not persisted to the database
  - addLastPersisted
```
public void addLastPersisted(ExternalValue value)
```
    Add to last persisted objects.
    
    Parameters:
    
    value -
  - getLastPersisted
```
public List<ExternalValue> getLastPersisted()
```
    Returns records persisted during last evaluation level merge.
    
    Returns:
    
    records persisted during last evaluation level merge
  - resetLastPersisted
```
public void resetLastPersisted()
```
    Resets last persisted.
  - addEntityHolder
```
public void addEntityHolder(Object entity,
                            ExternalRecordHolder holder)
```
    Adds entity - holder pair
    
    Parameters:
    
    entity -
    
    holder -
  - removeEntityHolder
```
public void removeEntityHolder(Object entity)
```
    Removes entity -holder pair
    
    Parameters:
    
    entity -
  - getHolderForEntity
```
public ExternalRecordHolder getHolderForEntity(Object entity)
```
    Returns holder for an entity.
    
    Parameters:
    
    entity -
    
    Returns:
    
    holder for an entity
  - getCurrentInvocationTimestamp
```
public Long getCurrentInvocationTimestamp()
```
    Returns current invocation timestamp
    
    Returns:
    
    current invocation timestamp
  - getCompatibilityVersion
```
public CompatibilityVersion getCompatibilityVersion(ModelProviderClientService modelProviderService)
```
    Returns compatibility version.
    
    Parameters:
    
    modelProviderService -
    
    Returns:
    
    compatibility
  - setCurrentToken
```
public void setCurrentToken(Token currentToken)
```
    Sets currently handled token.
    
    Parameters:
    
    currentToken -
  - getCurrentToken
```
public Token getCurrentToken()
```
    Gets currently handled token.
    
    Returns:
    
    currently handled token
  - setCurrentProcessInstance
```
public void setCurrentProcessInstance(ProcessInstance currentProcessInstance)
```
    Sets current process instance.
    
    Parameters:
    
    currentProcessInstance -
  - getCurrentProcessInstance
```
public ProcessInstance getCurrentProcessInstance()
```
    Gets current process instance.
    
    Returns:
    
    current process instance.
  - getCompiledContext
```
public CompiledContext getCompiledContext(ModelProviderClientService modelProviderService,
                                          String moduleName,
                                          String evaluationLevel)
```
  - isMonitoringChanged
```
public boolean isMonitoringChanged()
```
  - setIsMonitoringChange
```
public void setIsMonitoringChange(boolean value)
```

Class ModelInstance

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SCHEMA_NAMESPACE

Constructor Detail

ModelInstance

ModelInstance

ModelInstance

Method Detail

getId

setId

getModelId

setModelId

getModelInstanceMigrationId

setModelInstanceMigrationId

getModelName

setModelName

getModelVersion

setModelVersion

getModelHash

setModelHash

isCreateProcessLog

setCreateProcessLog

getProperties

getProperty

getState

setState

getType

isProcess

isDocument

isFormPreview

isEvaluation

isFinished

isDetached

getStartedDate

getFinishedDate

setStartedDate

setFinishedDate

getSignals

addSignal

addSignal

addSignal

removeSignal

addEscalation

removeEscalation

getEscalations

getIdAllocator

setIdAllocator

getDetachmentId

getDetachingTaskId

isUsingEvaluationLevels

getMaxAllocatedId

synchronizeIdSeq

getCurrentId

nextId

getCurrentInternalVersion

setCurrentInternalVersion

nextInternalVersion

getInitialInternalVersionFor

getParentId

getComplexValue

getComplexValue

addChangeListener

addChangeListeners

removeChangeListener

removeChangeListeners

removeChangeListeners

fireChange

addExternalRecordListener

removeExternalRecordListener

fireExternalRecordPropertyAccess

getExternalRecordListeners

getModelInstance

rebind

getContext

getContext

getAllLevelEntities