wt.workflow.definer
Interface WfNodeTemplate

All Superinterfaces:

NetFactor, ObjectMappable, Persistable, Serializable

All Known Subinterfaces:

ProjectNodeTemplate

All Known Implementing Classes:

MilestoneTemplate, ProjectActivityTemplate, ProjectProxyTemplate, SummaryActivityTemplate, WfConnectorTemplate, WfTemplateObject

public interface WfNodeTemplate

extends Persistable

WfNodeTemplate is an interface representing obejcts that can play a role of a node in a workflow. These objects are the template objects, connectors and routers.

Supported API: false

Extendable: false

Field Summary

static String	PARENT_TEMPLATE Label for the attribute; Reference to parent template.
static String	ROUTER_TYPE Label for the attribute; Type of the router (NONE, MANUAL, or CONDITIONAL).
static String	USER_EVENT_LIST Label for the attribute; Event list associated to the node.
static String	X_COORD Label for the attribute; X coordinate of the template's position.
static String	Y_COORD Label for the attribute; Y coodinate of the template's position.

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Method Summary

boolean	addUserEvent(Object usr_evt) Adds event to node (in case of router node).
WfNode	createWfNode(WfContainer container) Creates a (persistent) node instance from the template.
Enumeration	getDestinationActions() Return all events that can occur with the object as destination of a workflow link.
WfContainerTemplateReference	getParentTemplate() Gets the value of the attribute: PARENT_TEMPLATE.
Enumeration	getPredecessors() This method returns an enumeration (of type NodeTemplateLink) containing the predecessor links of the template.
WfRouterType	getRouterType() Gets the value of the attribute: ROUTER_TYPE.
Enumeration	getSourceEvents() Return all events that can occur with the object as source of a workflow link.
Enumeration	getSuccessors() This method returns an enumeration (of type NodeTemplateLink) containing the successor links of the template.
UserEventVector	getUserEventList() Gets the value of the attribute: USER_EVENT_LIST.
Object[]	getUserEvents() Returns an enumeration containing all events defined for the node.
long	getXCoord() Gets the value of the attribute: X_COORD.
long	getYCoord() Gets the value of the attribute: Y_COORD.
boolean	removeUserEvent(Object usr_evt) Removes event from node (for router nodes).
void	setRouterType(WfRouterType a_RouterType) Sets the value of the attribute: ROUTER_TYPE.
void	setUserEventList(UserEventVector a_UserEventList) Sets the value of the attribute: USER_EVENT_LIST.
void	setXCoord(long a_XCoord) Sets the value of the attribute: X_COORD.
void	setYCoord(long a_YCoord) Sets the value of the attribute: Y_COORD.

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.ObjectMappable

readExternal, writeExternal

Methods inherited from interface wt.fc.NetFactor

getClassInfo, getConceptualClassname

Field Detail

X_COORD

public static final String X_COORD

Label for the attribute; X coordinate of the template's position.

Supported API: false

See Also:

Constant Field Values

Y_COORD

public static final String Y_COORD

Label for the attribute; Y coodinate of the template's position.

Supported API: false

See Also:

Constant Field Values

ROUTER_TYPE

public static final String ROUTER_TYPE

Label for the attribute; Type of the router (NONE, MANUAL, or CONDITIONAL).

Supported API: false

See Also:

Constant Field Values

USER_EVENT_LIST

public static final String USER_EVENT_LIST

Label for the attribute; Event list associated to the node. Makes sense only for router nodes.

Supported API: false

See Also:

Constant Field Values

PARENT_TEMPLATE

public static final String PARENT_TEMPLATE

Label for the attribute; Reference to parent template. Null if template has no parent.

Supported API: false

See Also:

Constant Field Values

Method Detail

getXCoord

public long getXCoord()

Gets the value of the attribute: X_COORD. X coordinate of the template's position.

Supported API: false

Returns:

long

setXCoord

public void setXCoord(long a_XCoord)
               throws WTPropertyVetoException

Sets the value of the attribute: X_COORD. X coordinate of the template's position.

Supported API: false

Parameters:

a_XCoord -

Throws:

WTPropertyVetoException

getYCoord

public long getYCoord()

Gets the value of the attribute: Y_COORD. Y coodinate of the template's position.

Supported API: false

Returns:

long

setYCoord

public void setYCoord(long a_YCoord)
               throws WTPropertyVetoException

Sets the value of the attribute: Y_COORD. Y coodinate of the template's position.

Supported API: false

Parameters:

a_YCoord -

Throws:

WTPropertyVetoException

getRouterType

public WfRouterType getRouterType()

Gets the value of the attribute: ROUTER_TYPE. Type of the router (NONE, MANUAL, or CONDITIONAL).

Supported API: false

Returns:

WfRouterType

setRouterType

public void setRouterType(WfRouterType a_RouterType)

Sets the value of the attribute: ROUTER_TYPE. Type of the router (NONE, MANUAL, or CONDITIONAL).

Supported API: false

Parameters:

a_RouterType -

getUserEventList

public UserEventVector getUserEventList()

Gets the value of the attribute: USER_EVENT_LIST. Event list associated to the node. Makes sense only for router nodes.

Supported API: false

Returns:

UserEventVector

setUserEventList

public void setUserEventList(UserEventVector a_UserEventList)

Sets the value of the attribute: USER_EVENT_LIST. Event list associated to the node. Makes sense only for router nodes.

Supported API: false

Parameters:

a_UserEventList -

getParentTemplate

public WfContainerTemplateReference getParentTemplate()

Gets the value of the attribute: PARENT_TEMPLATE. Reference to parent template. Null if template has no parent.

Supported API: false

Returns:

WfContainerTemplateReference

getSuccessors

public Enumeration getSuccessors()
                          throws WTException

This method returns an enumeration (of type NodeTemplateLink) containing the successor links of the template. For non-embedded templates, this enumeration is empty, of course.

Supported API: false

Returns:

Enumeration

Throws:

WTException

getPredecessors

public Enumeration getPredecessors()
                            throws WTException

This method returns an enumeration (of type NodeTemplateLink) containing the predecessor links of the template. For non-embedded templates, this enumeration is empty, of course.

Supported API: false

Returns:

Enumeration

Throws:

WTException

getSourceEvents

public Enumeration getSourceEvents()

Return all events that can occur with the object as source of a workflow link.

Supported API: false

Returns:

Enumeration

getDestinationActions

public Enumeration getDestinationActions()

Return all events that can occur with the object as destination of a workflow link.

Supported API: false

Returns:

Enumeration

createWfNode

public WfNode createWfNode(WfContainer container)
                    throws WTException

Creates a (persistent) node instance from the template. This method has to be implemented by all classes that implement WfNodeTemplate.

For activity templates, the pattern is the following:

 public WfNode createWfNode (WfContainer container)
          throws WTException {
     instance = .new (container);
    setAttributes (instance);
    return (WfNode) PersistenceHelper.manager.save (instance);
 }
 

where is the name of the class of the instance object. For example "WfAssignedActivity". Note that every activity type must have a constructor that that takes a WfContainer object as argument. This container is the parent container and must be passed to the super classes for initialization.

Supported API: false

Parameters:

container -

Returns:

WfNode

Throws:

WTException

addUserEvent

public boolean addUserEvent(Object usr_evt)

Adds event to node (in case of router node).

Supported API: false

Parameters:

usr_evt -

Returns:

boolean

removeUserEvent

public boolean removeUserEvent(Object usr_evt)

Removes event from node (for router nodes).

Supported API: false

Parameters:

usr_evt -

Returns:

boolean

getUserEvents

public Object[] getUserEvents()

Returns an enumeration containing all events defined for the node.

Supported API: false

Returns:

Object[]