com.whitestein.lsps.engine.state.xml

Class Plan

java.lang.Object

com.whitestein.lsps.engine.state.xml.GOElement

com.whitestein.lsps.engine.state.xml.Plan

All Implemented Interfaces:

UnmarshalCallback, ElementInProcess, ModelIdentifiable, ModelInstanceAware, XmlEntity

public class Plan
extends GOElement

Entity representing plan execution state.

Author:

rba

Field Summary

Fields inherited from class com.whitestein.lsps.engine.state.xml.GOElement

modelInstance, parentGoal, processInstance

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Plan() Creates new empty instance of Plan.
	Plan(ProcessInstance processInstance, String name, Goal parentGoal) Creates new instance of Plan.
	Plan(ProcessInstance processInstance, String name, Goal parentGoal, PlanState state) Creates new instance of Plan.

Method Summary

Modifier and Type	Method and Description
Collection<GOElement>	getChildren() Returns unmodifiable collection of children go elements.
com.whitestein.lsps.model.Plan	getElement(ModelProviderClientService modelProviderService) Returns the model element.
String	getElementId(ModelProviderClientService modelProviderService) Returns the model element id.
ProcessInstance	getPlanProcessInstance() Returns the process instance of the plan.
PlanState	getState() Returns the plan state.
Plan	makeCopy(ModelInstance targetModelInstance, ProcessInstance targetProcessInstance, Goal targetParentGoal) Returns deep copy.
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	setPlanProcessInstance(ProcessInstance processInstance) Sets the plan context.
void	setState(PlanState state) Sets new plan state

Methods inherited from class com.whitestein.lsps.engine.state.xml.GOElement

fireChange, getModelInstance, getName, getParentGoal, getPath, getPathQID, getProcessInstance, rebind, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Plan

protected Plan()

Creates new empty instance of Plan.

Plan

public Plan(ProcessInstance processInstance,
            String name,
            Goal parentGoal)

Creates new instance of Plan.

Parameters:

processInstance -

name -

parentGoal -

Throws:

NullPointerException - if processInstance or moduleInstance or name is null

Plan

public Plan(ProcessInstance processInstance,
            String name,
            Goal parentGoal,
            PlanState state)

Creates new instance of Plan.

Parameters:

processInstance -

name -

parentGoal -

state -

Throws:

NullPointerException - if processInstance or moduleInstance or name or state or parentGoal is null

Method Detail

getState

public PlanState getState()

Returns the plan state.

Returns:

the plan state

setState

public void setState(PlanState state)

Sets new plan state

Parameters:

state -

Throws:

NullPointerException - if state is null

getPlanProcessInstance

public ProcessInstance getPlanProcessInstance()

Returns the process instance of the plan.

Returns:

the process instance of the plan

setPlanProcessInstance

public void setPlanProcessInstance(ProcessInstance processInstance)

Sets the plan context.

Parameters:

processInstance -

getElement

public com.whitestein.lsps.model.Plan getElement(ModelProviderClientService modelProviderService)

Description copied from interface: ModelIdentifiable

Returns the model element.

Returns:

the model element

getElementId

public String getElementId(ModelProviderClientService modelProviderService)

Description copied from interface: ModelIdentifiable

Returns the model element id.

Returns:

the model element id

getChildren

public Collection<GOElement> getChildren()

Description copied from class: GOElement

Returns unmodifiable collection of children go elements.

Specified by:

getChildren in class GOElement

Returns:

collection of children go elements

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.

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.

parent - instance of JAXB mapped class that will reference target. null when target is root element.

makeCopy

public Plan makeCopy(ModelInstance targetModelInstance,
                     ProcessInstance targetProcessInstance,
                     Goal targetParentGoal)

Description copied from class: GOElement

Returns deep copy.

Specified by:

makeCopy in class GOElement

Returns:

deep copy