com.whitestein.lsps.engine.state.xml

Class Goal

java.lang.Object

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

com.whitestein.lsps.engine.state.xml.Goal

All Implemented Interfaces:

UnmarshalCallback, ElementInProcess, ModelIdentifiable, ModelInstanceAware, XmlEntity

public class Goal
extends GOElement

Entity representing goal 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	Goal() Creates new empty instance of Goal.
	Goal(ProcessInstance processInstance, String name, GoalType goalType, Goal parentGoal) Creates new instance of Goal with default state GoalState.INACTIVE.
	Goal(ProcessInstance processInstance, String name, GoalType goalType, Goal parentGoal, GoalState state) Creates new instance of Goal.

Method Summary

Modifier and Type	Method and Description
void	addChild(GOElement element) Adds child.
List<Goal>	getAllSubGoals()
Collection<GOElement>	getChildren() Returns unmodifiable collection of children go elements.
com.whitestein.lsps.model.Goal	getElement(ModelProviderClientService modelProviderService) Returns the model element.
String	getElementId(ModelProviderClientService modelProviderService) Returns the model element id.
GoalType	getGoalType() Returns the goal type.
GoalState	getState() Returns the goal state.
List<Goal>	getSubGoals()
boolean	isTop() Returns if this is top goal.
Goal	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	setState(GoalState state) Sets new goal 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

Goal

protected Goal()

Creates new empty instance of Goal.

Goal

public Goal(ProcessInstance processInstance,
            String name,
            GoalType goalType,
            Goal parentGoal)

Creates new instance of Goal with default state GoalState.INACTIVE.

Parameters:

processInstance -

name -

goalType -

parentGoal -

Throws:

NullPointerException - if processInstance or moduleInstance or name or goalType is null

Goal

public Goal(ProcessInstance processInstance,
            String name,
            GoalType goalType,
            Goal parentGoal,
            GoalState state)

Creates new instance of Goal.

Parameters:

processInstance -

name -

goalType -

parentGoal -

state -

Throws:

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

Method Detail

getState

public GoalState getState()

Returns the goal state.

Returns:

the goal state

getGoalType

public GoalType getGoalType()

Returns the goal type.

Returns:

the goal type

isTop

public boolean isTop()

Returns if this is top goal.

Returns:

if this is top goal

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

addChild

public void addChild(GOElement element)

Adds child.

Parameters:

element -

Throws:

NullPointerException - if element is null

setState

public void setState(GoalState state)

Sets new goal state.

Parameters:

state -

Throws:

NullPointerException - if goalState is null

getElement

public com.whitestein.lsps.model.Goal 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

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 Goal makeCopy(ModelInstance targetModelInstance,
                     ProcessInstance targetProcessInstance,
                     Goal targetParentGoal)

Description copied from class: GOElement

Returns deep copy.

Specified by:

makeCopy in class GOElement

Returns:

deep copy

getSubGoals

public List<Goal> getSubGoals()

Returns:

a list of achieve sub-goals

getAllSubGoals

public List<Goal> getAllSubGoals()

Returns:

a list of all achieve sub-goals (recursively)