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:

ElementInProcess, ModelIdentifiable, ModelInstanceAware

public class Plan
extends GOElement

Entity representing plan execution state.

Author:

rba

Constructor Summary

Constructors

Constructor and Description
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.
Plan(SPlan source, Goal parent, ProcessInstance processInstance, ModelInstance modelInstance) Creates a new instance from the serialized companion.

Method Summary

Modifier and Type	Method and Description
Plan	createCopy(ModelInstance targetModelInstance, ProcessInstance targetProcessInstance, Goal targetParentGoal)
Collection<GOElement>	getChildren() Returns unmodifiable collection of children go elements.
com.whitestein.lsps.model.Plan	getElement(ModelProvider modelProvider) Returns the model element.
String	getElementId(ModelProvider modelProvider) Returns the model element id.
ProcessInstance	getPlanProcessInstance() Returns the process instance of the plan.
PlanState	getState() Returns the plan state.
void	setPlanProcessInstance(ProcessInstance processInstance) Sets the plan context.
void	setState(PlanState state) Sets new plan state
SGOElement	toSerializable(SModelInstance smi, MarshallerConfig config) Creates a serializable object.

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

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

Plan

public Plan(SPlan source,
            Goal parent,
            ProcessInstance processInstance,
            ModelInstance modelInstance)

Creates a new instance from the serialized companion.

Parameters:

source -

parent -

processInstance -

modelInstance -

Method Detail

toSerializable

public SGOElement toSerializable(SModelInstance smi,
                                 MarshallerConfig config)

Description copied from class: GOElement

Creates a serializable object.

Specified by:

toSerializable in class GOElement

Returns:

the created serializable object

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(ModelProvider modelProvider)

Description copied from interface: ModelIdentifiable

Returns the model element.

Returns:

the model element

getElementId

public String getElementId(ModelProvider modelProvider)

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

createCopy

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