com.netscape.pm.model
Interface ITransition

All Superinterfaces:

IPMElement, ISortable

public interface ITransition

extends IPMElement, ISortable

Defines a transition element object connecting separate node elements together. A transition is graphically represented as an arrow extending from one node to another node on the process map in the builder. It is a means for the engine to complete a work item at one node and spawn a new set of work items at the next set of nodes as defined in the process.

ITransitions are created during application initialization and are managed by the nodes that they extend from. The current design of the engine does not allow for dynamic manipulation of the process definition during run-time, thus attempts to access the mutators on this object will result in run-time exceptions.

See Also:

INodeElement, IPMElement, ISortable

Method Summary

boolean	allows(IWorkItem wi) Asks the transition to determine whether the current work item qualifies for following this transition.
INodeElement	getSourceNode() Returns the node element this transition is pointing from.
INodeElement	getTargetNode() Returns the node element this transition is pointing to.
boolean	isVirtual() Returns true if this transition is a virtual transition.

Methods inherited from interface com.netscape.pm.model.IPMElement

dumpState, getDescription, getName, getParent, getPrettyName, getProperty, isLocked, lockObject, postCreation, setParent, setProperties, toString

Methods inherited from interface com.netscape.pm.model.ISortable

compareTo, getEvaluationOrder

Method Detail

getTargetNode

public INodeElement getTargetNode()

Returns the node element this transition is pointing to.

Returns:

the node element this transition is pointing to.

Since:

PAE 4.0

See Also:

INodeElement

getSourceNode

public INodeElement getSourceNode()

Returns the node element this transition is pointing from.

Returns:

the node element this transition is pointing from.

Since:

PM 6.0

See Also:

INodeElement

allows

public boolean allows(IWorkItem wi)
               throws PMException

Asks the transition to determine whether the current work item qualifies for following this transition. For instance, if the user is trying to complete the current work item, this transition will attempt to compare the conclusion from the work item (see the work item method getConclusion) with the name of the current transition to determine if this transition is the one to follow.

Parameters:

wi - the current work item being completed

Returns:

true if the transition can be followed; false otherwise.

Throws:

PMException - if there is a problem with determining whether the work item can follow the transition.

Since:

PAE 4.0

See Also:

IWorkItem

isVirtual

public boolean isVirtual()

Returns true if this transition is a virtual transition. Virtual transitions are different from regular transitions since they are only available to be followed during moveTo operations (see the IPMApplication method moveTo for more information).

Returns:

true if this transition is a virtual transition; false otherwise.

Since:

PAE 4.0

See Also:

IPMApplication.moveTo(com.netscape.pm.model.IWorkItem, com.netscape.pm.model.INodeElement)