com.whitestein.lsps.engine.state.xml

Class Escalation

java.lang.Object

com.whitestein.lsps.engine.state.xml.Escalation

All Implemented Interfaces:

Collectible, EntityWithId, ModelInstanceAware

public class Escalation
extends Object
implements Collectible, ModelInstanceAware, EntityWithId

This class represents an escalation which is thrown by an escalation throw event.

Author:

jsa

Constructor Summary

Constructors

Constructor and Description
Escalation(ModelInstance modelInstance, long processInstanceId, String elementId, String escalationCode, Value payload) Creates a new escalation event with the given escalation code and it's payload.
Escalation(ProcessInstance processInstance, String elementId, String escalationCode, Value payload) Creates a new escalation event with the given escalation code and it's payload.
Escalation(SEscalation source, ModelInstance modelInstance) Creates a new instance from the serialized companion.

Method Summary

Modifier and Type	Method and Description
void	collect() Removes itself from the process.
Escalation	createCopy(ModelInstance targetModelInstance) Creates a copy without references to other objects.
void	finishCopy(com.whitestein.lsps.engine.state.xml.Copiable source, CopyHelper helper) Copy references.
String	getElementId() Gets the identifier of the escalation flow element which generated this escalation.
String	getEscalationCode() Gets the code of this escalation.
long	getId() Returns the id.
ModelInstance	getModelInstance() Returns the model instance.
Value	getPayload() Gets payload of this escalation.
ProcessInstance	getProcessInstance() Returns the process instance in which this escalation was generated.
long	getProcessInstanceId() Gets the identifier of the process instance in which this escalation was generated.
Collection<Collectible>	getReferences() Returns collection of all referenced collectible objects.
boolean	isInserted() Indicates if the escalation was inserted into a model instance in the current iteration of the process agent loop.
boolean	isPersistent() Returns true if this object cannot be collected.
void	rebind(ModelInstance modelInstance) Re-bind to the provided model instance.
void	setInserted(boolean inserted) Sets the inserted flag.
SEscalation	toSerializable(SModelInstance smi, MarshallerConfig config) Creates a serializable object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Escalation

public Escalation(ProcessInstance processInstance,
                  String elementId,
                  String escalationCode,
                  Value payload)

Creates a new escalation event with the given escalation code and it's payload.

Parameters:

processInstance - the process instance this escalation was created in

elementId - the identifier of the flow element which generated this escalation

escalationCode - the code identifying this escalation

payload - the payload of the escalation event

Escalation

public Escalation(ModelInstance modelInstance,
                  long processInstanceId,
                  String elementId,
                  String escalationCode,
                  Value payload)

Creates a new escalation event with the given escalation code and it's payload.

Parameters:

modelInstance - the model instance

processInstanceId - the identifier of a process instance this escalation was created in

elementId - the identifier of the flow element which generated this escalation

escalationCode - the code identifying this escalation

payload - the payload of the escalation event

Escalation

public Escalation(SEscalation source,
                  ModelInstance modelInstance)

Creates a new instance from the serialized companion.

Parameters:

source -

modelInstance -

Method Detail

toSerializable

public SEscalation toSerializable(SModelInstance smi,
                                  MarshallerConfig config)

Creates a serializable object.

Parameters:

smi -

config -

Returns:

a serializable object

getEscalationCode

public String getEscalationCode()

Gets the code of this escalation. The code can be used to match the escalation event flow which should consume this escalation.

Returns:

the escalation code

getElementId

public String getElementId()

Gets the identifier of the escalation flow element which generated this escalation.

Returns:

the element identifier

getProcessInstanceId

public long getProcessInstanceId()

Gets the identifier of the process instance in which this escalation was generated.

Returns:

the process instance identifier

getProcessInstance

public ProcessInstance getProcessInstance()

Returns the process instance in which this escalation was generated.

Returns:

the process instance

getPayload

public Value getPayload()

Gets payload of this escalation.

Returns:

the payload

isInserted

public boolean isInserted()

Indicates if the escalation was inserted into a model instance in the current iteration of the process agent loop.

Returns:

true if this escalation has been inserted in the model instance in the current iteration of the process agent loop.

setInserted

public void setInserted(boolean inserted)

Sets the inserted flag.

Parameters:

inserted -

See Also:

isInserted()

getId

public long getId()

Description copied from interface: EntityWithId

Returns the id.

Specified by:

getId in interface EntityWithId

Returns:

the id

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

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

createCopy

public Escalation createCopy(ModelInstance targetModelInstance)

Creates a copy without references to other objects.

Returns:

creates a copy

finishCopy

public void finishCopy(com.whitestein.lsps.engine.state.xml.Copiable source,
                       CopyHelper helper)

Copy references.