com.netscape.pm.model
Interface IProcessMap

public interface IProcessMap

Defines an object that will contain all of the nodes defined for the current application; that is, all the nodes visible from the process map in the builder. The object that implements IProcessMap is part of the application's process definition; a handle to the process map can be obtained via the IProcessDefinition interface.

See Also:

INodeElement, IProcessDefinition

Method Summary

java.util.Enumeration	activityNodes() Returns an enumeration of all the activity nodes defined in the process map for the current application.
java.util.Enumeration	automatedNodes() Returns an enumeration of all the automated nodes defined in the process map for the current application.
java.util.Enumeration	entryNodes() Returns an enumeration of all the entry point nodes defined in the process map for the current application.
java.util.Enumeration	exceptionNodes() Returns an enumeration of all the exception nodes defined in the process map for the current application.
java.util.Enumeration	exitNodes() Returns an enumeration of all the exit point nodes defined in the process map for the current application.
java.lang.String	getAutomatedNodesPDM() Returns a string (in the format of a JavaScript hashtable definition) of the names of all the automated nodes defined in the process map.
INodeElement	getNodeElement(java.lang.String neName) Returns a handle to the specified node element.
java.util.Enumeration	nodes() Returns an enumeration of all the nodes defined in the process map for the current application.

Method Detail

nodes

public java.util.Enumeration nodes()

Returns an enumeration of all the nodes defined in the process map for the current application.

Returns:

java.util.Enumeration of INodeElement objects.

Since:

PAE 4.0

See Also:

INodeElement

entryNodes

public java.util.Enumeration entryNodes()

Returns an enumeration of all the entry point nodes defined in the process map for the current application.

Returns:

java.util.Enumeration of INodeElement objects.

Since:

PAE 4.0

See Also:

INodeElement

activityNodes

public java.util.Enumeration activityNodes()

Returns an enumeration of all the activity nodes defined in the process map for the current application. Activity nodes are defined as being nodes that are assigned to users and require some form of manual interaction to complete; this does not include exception nodes however.

Returns:

java.util.Enumeration of INodeElement objects.

Since:

PAE 4.0

See Also:

INodeElement

exceptionNodes

public java.util.Enumeration exceptionNodes()

Returns an enumeration of all the exception nodes defined in the process map for the current application.

Returns:

java.util.Enumeration of INodeElement objects.

Since:

PAE 4.0

See Also:

INodeElement

exitNodes

public java.util.Enumeration exitNodes()

Returns an enumeration of all the exit point nodes defined in the process map for the current application.

Returns:

java.util.Enumeration of INodeElement objects.

Since:

PAE 4.0

See Also:

INodeElement

automatedNodes

public java.util.Enumeration automatedNodes()

Returns an enumeration of all the automated nodes defined in the process map for the current application. A node is considered to be automated if the entity performing the work of the node is the engine; as opposed to activity nodes where the performer is the user that is assigned to the workitem.

Returns:

java.util.Enumeration of INodeElement objects.

Since:

PAE 4.0

See Also:

INodeElement

getAutomatedNodesPDM

public java.lang.String getAutomatedNodesPDM()

Returns a string (in the format of a JavaScript hashtable definition) of the names of all the automated nodes defined in the process map. This method is used by the engine's event handler UI to return a list of automated nodes to the client-side JavaScript layer. Users will probably not find this method of much use, and should just ignore it.

Returns:

a string containing the current list of automated nodes.

Since:

PAE 4.0

getNodeElement

public INodeElement getNodeElement(java.lang.String neName)
                            throws PMException

Returns a handle to the specified node element. The name of the node is its common name, that is the label applied to the node on the process map in the builder.

Parameters:

neName - the name of the node element to access

Returns:

the node element that corresponds to the specified name.

Throws:

PMException - if there is no such node element defined in the process map for the current application.

Since:

PAE 4.0

See Also:

INodeElement