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:

ElementInProcess, ModelIdentifiable, ModelInstanceAware

public class Goal
extends GOElement

Entity representing goal execution state.

Author:

rba

Constructor Summary

Constructors

Constructor and Description
Goal(ProcessInstance processInstance, java.lang.String name, GoalType goalType, Goal parentGoal) Creates new instance of Goal with default state GoalState.INACTIVE.
Goal(ProcessInstance processInstance, java.lang.String name, GoalType goalType, Goal parentGoal, GoalState state) Creates new instance of Goal.
Goal(SGoal s, Goal parent, ProcessInstance processInstance, ModelInstance modelInstance) Creates a new instance from the serialized companion.

Method Summary

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

Goal

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

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

Parameters:

processInstance -

name -

goalType -

parentGoal -

Throws:

java.lang.NullPointerException - if processInstance or moduleInstance or name or goalType is null

Goal

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

Creates new instance of Goal.

Parameters:

processInstance -

name -

goalType -

parentGoal -

state -

Throws:

java.lang.NullPointerException - if processInstance or moduleInstance or name or goalType or state is null

Goal

public Goal(SGoal s,
            Goal parent,
            ProcessInstance processInstance,
            ModelInstance modelInstance)

Creates a new instance from the serialized companion.

Parameters:

s -

parent -

processInstance -

modelInstance -

Method Detail

toSerializable

public SGoal 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 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 java.util.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:

java.lang.NullPointerException - if element is null

setState

public void setState(GoalState state)

Sets new goal state.

Parameters:

state -

Throws:

java.lang.NullPointerException - if goalState is null

getElement

public com.whitestein.lsps.model.Goal getElement(ModelProvider modelProvider)

Description copied from interface: ModelIdentifiable

Returns the model element.

Returns:

the model element

getElementId

public java.lang.String getElementId(ModelProvider modelProvider)

Description copied from interface: ModelIdentifiable

Returns the model element id.

Returns:

the model element id

getSubGoals

public java.util.List<Goal> getSubGoals()

Returns:

a list of achieve sub-goals

getAllSubGoals

public java.util.List<Goal> getAllSubGoals()

Returns:

a list of all achieve sub-goals (recursively)