com.whitestein.lsps.engine.state.ser

Class SModelInstance

java.lang.Object

com.whitestein.lsps.engine.state.ser.SModelInstance

All Implemented Interfaces:

UnmarshalCallback, SXmlEntity

public class SModelInstance
extends java.lang.Object
implements SXmlEntity

Entity representing a model instance state.

Author:

rba

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SCHEMA_NAMESPACE ModelInstance schema namespace.

Constructor Summary

Constructors

Constructor and Description
SModelInstance() Creates new empty instance of SModelInstance.

Method Summary

Modifier and Type	Method and Description
void	addEscalation(SEscalation escalation)
void	addLog(SProcessLog log)
void	addModuleInstance(SModuleInstance moduleInstance)
void	addProxySet(SRecordProxySet proxySet)
void	addSignal(SSignal signal)
void	addTopNoBaseLevelContext(SContext c)
void	addValue(SComplexValue value)
long	getCurrentInternalVersion() Returns current internal version,
java.lang.Long	getDetachingTaskId() Returns id of a task for which the detached model instance is created.
java.lang.Long	getDetachmentId() Returns the last allocated detachment id.
java.lang.String	getDocumentDescription() Gets a description of a document or null if no document description has been set for this model instance.
java.util.List<SEscalation>	getEscalations() Returns a new list which holds all escalations in the model instance.
java.util.Set<java.lang.String>	getEvaluationLevelsOnDetach() Set of used evaluation levels at the moment of detachment.
java.util.Date	getFinishedDate() Returns the finished date.
java.lang.Long	getId() Returns the id.
long	getIdSeq() Returns the current id.
long	getInternalVersionSeq()
java.util.List<SProcessLog>	getLogs() Returns list of process logs.
long	getMaxAllocatedId() Returns maximal allocated id.
java.lang.String	getModelHash() Returns the model hash.
long	getModelId() Returns the model id.
java.lang.Long	getModelInstanceMigrationId() Returns the model instance migration id.
java.lang.String	getModelName() Returns the model name.
java.lang.String	getModelVersion() Returns the model version.
java.util.Collection<SModuleInstance>	getModuleInstances() Returns all modules in this model instance.
java.lang.Long	getParentId() Returns the parent id.
java.util.Map<java.lang.String,java.lang.String>	getProperties() Returns the properties
java.util.Set<SRecordProxySet>	getProxySets()
java.util.Collection<SSignal>	getSignals() Returns the signals as an unmodifiable view.
java.util.Date	getStartedDate() Returns the started date.
ModelInstanceState	getState() Returns life-cycle state.
java.util.Set<SContext>	getTopNoBaseLevelContexts() Returns top contexts from evaluation levels higher that base level.
ModelInstanceType	getType() Returns model instance type.
java.util.Collection<SComplexValue>	getValues() Returns the model instance complex values.
boolean	isCreateProcessLog()
boolean	isDetached() Returns true if the model instance is detached.
boolean	isDirty() Returns true if the model instance is dirty.
boolean	isFinished() Returns true if the model instance is finished.
boolean	isTrackingDirty() Returns true if tracking of dirtiness is switched on.
boolean	isUsingEvaluationLevels() Returns true is a detached model instance is using evaluation levels.
void	postUnmarshal(javax.xml.bind.Unmarshaller unmarshaller, java.lang.Object parent) Callback method invoked after unmarshalling XML data into target.
void	preUnmarshal(javax.xml.bind.Unmarshaller unmarshaller, java.lang.Object parent) Callback method invoked before unmarshalling into target.
void	setCreateProcessLog(boolean createProcessLog)
void	setDetachingTaskId(java.lang.Long detachingTaskId)
void	setDetachmentId(java.lang.Long detachmentId)
void	setDirty(boolean isDirty) Sets isDirty.
void	setDocumentDescription(java.lang.String documentDescription) Sets the description of a document for this model instance.
void	setEvaluationLevelsOnDetach(java.util.Set<java.lang.String> evaluationLevelsOnDetach)
void	setFinishedDate(java.util.Date finishedDate) Sets the finished date.
void	setId(java.lang.Long id) Sets the id.
void	setIdSeq(long idSeq)
void	setInternalVersionSeq(long internalVersionSeq)
void	setMaxAllocatedId(long maxAllocatedId)
void	setModelHash(java.lang.String modelHash) Sets the model hash.
void	setModelId(long modelId) Sets the model id.
void	setModelInstanceMigrationId(java.lang.Long modelInstanceMigrationId) Sets the model instance migration id.
void	setModelName(java.lang.String modelName) Sets the model name.
void	setModelVersion(java.lang.String modelVersion) Sets the model version.
void	setParentId(java.lang.Long parentId)
void	setProperties(java.util.Map<java.lang.String,java.lang.String> map)
void	setStartedDate(java.util.Date startedDate) Sets the started date.
void	setState(ModelInstanceState state)
void	setTrackingDirty(boolean isTrackingDirty) Switch on/off checking of dirtiness.
void	setType(ModelInstanceType type)
void	setUsingEvaluationLevels(boolean b)
java.lang.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 java.lang.String SCHEMA_NAMESPACE

ModelInstance schema namespace.

See Also:

Constant Field Values

Constructor Detail

SModelInstance

public SModelInstance()

Creates new empty instance of SModelInstance.

Method Detail

getId

public java.lang.Long getId()

Returns the id.

Returns:

the id

setId

public void setId(java.lang.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 java.lang.Long getModelInstanceMigrationId()

Returns the model instance migration id.

Returns:

the model instance migration id

setModelInstanceMigrationId

public void setModelInstanceMigrationId(java.lang.Long modelInstanceMigrationId)

Sets the model instance migration id.

Parameters:

modelInstanceMigrationId -

getModelName

public java.lang.String getModelName()

Returns the model name.

Returns:

the model name

setModelName

public void setModelName(java.lang.String modelName)

Sets the model name.

Parameters:

modelName -

getModelVersion

public java.lang.String getModelVersion()

Returns the model version.

Returns:

the model version

setModelVersion

public void setModelVersion(java.lang.String modelVersion)

Sets the model version.

Parameters:

modelVersion -

getModelHash

public java.lang.String getModelHash()

Returns the model hash.

Returns:

the model hash

setModelHash

public void setModelHash(java.lang.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 java.util.Map<java.lang.String,java.lang.String> getProperties()

Returns the properties

Returns:

properties

setProperties

public void setProperties(java.util.Map<java.lang.String,java.lang.String> map)

getState

public ModelInstanceState getState()

Returns life-cycle state.

Returns:

life-cycle state

setState

public void setState(ModelInstanceState state)

getType

public ModelInstanceType getType()

Returns model instance type.

Returns:

model instance type

setType

public void setType(ModelInstanceType type)

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 java.util.Date getStartedDate()

Returns the started date.

Returns:

the started date

getFinishedDate

public java.util.Date getFinishedDate()

Returns the finished date.

Returns:

the finished date

setStartedDate

public void setStartedDate(java.util.Date startedDate)

Sets the started date.

Parameters:

startedDate -

setFinishedDate

public void setFinishedDate(java.util.Date finishedDate)

Sets the finished date.

Parameters:

finishedDate -

getSignals

public java.util.Collection<SSignal> getSignals()

Returns the signals as an unmodifiable view.

Returns:

the signals as an unmodifiable view

addSignal

public void addSignal(SSignal signal)

getEscalations

public java.util.List<SEscalation> getEscalations()

Returns a new list which holds all escalations in the model instance.

Returns:

the escalations in a new list

addEscalation

public void addEscalation(SEscalation escalation)

getDetachmentId

public java.lang.Long getDetachmentId()

Returns the last allocated detachment id.

Returns:

the last allocated detachment id

setDetachmentId

public void setDetachmentId(java.lang.Long detachmentId)

getDetachingTaskId

public java.lang.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

setDetachingTaskId

public void setDetachingTaskId(java.lang.Long detachingTaskId)

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

setUsingEvaluationLevels

public void setUsingEvaluationLevels(boolean b)

getMaxAllocatedId

public long getMaxAllocatedId()

Returns maximal allocated id.

Returns:

maximal allocated id

setMaxAllocatedId

public void setMaxAllocatedId(long maxAllocatedId)

getIdSeq

public long getIdSeq()

Returns the current id.

Returns:

the current id

setIdSeq

public void setIdSeq(long idSeq)

getInternalVersionSeq

public long getInternalVersionSeq()

Returns:

the internal version seq id

setInternalVersionSeq

public void setInternalVersionSeq(long internalVersionSeq)

getCurrentInternalVersion

public long getCurrentInternalVersion()

Returns current internal version,

Returns:

current internal version

getParentId

public java.lang.Long getParentId()

Returns the parent id.

Returns:

parent id

setParentId

public void setParentId(java.lang.Long parentId)

getValues

public java.util.Collection<SComplexValue> getValues()

Returns the model instance complex values.

Returns:

the model instance complex values

addValue

public void addValue(SComplexValue value)

getModuleInstances

public java.util.Collection<SModuleInstance> getModuleInstances()

Returns all modules in this model instance.

Returns:

all modules in this model instance

addModuleInstance

public void addModuleInstance(SModuleInstance moduleInstance)

getLogs

public java.util.List<SProcessLog> getLogs()

Returns list of process logs.

Returns:

list of process logs

addLog

public void addLog(SProcessLog log)

getTopNoBaseLevelContexts

public java.util.Set<SContext> 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(SContext c)

getEvaluationLevelsOnDetach

public java.util.Set<java.lang.String> getEvaluationLevelsOnDetach()

Set of used evaluation levels at the moment of detachment.

Returns:

set of used evaluation levels at the moment of detachment

setEvaluationLevelsOnDetach

public void setEvaluationLevelsOnDetach(java.util.Set<java.lang.String> evaluationLevelsOnDetach)

preUnmarshal

public void preUnmarshal(javax.xml.bind.Unmarshaller unmarshaller,
                         java.lang.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,
                          java.lang.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.

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 java.lang.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(java.lang.String documentDescription)

Sets the description of a document for this model instance.

Parameters:

documentDescription - the document description

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

addProxySet

public void addProxySet(SRecordProxySet proxySet)

getProxySets

public java.util.Set<SRecordProxySet> getProxySets()