Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKRouteListEntryICM

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKRouteListEntryICM
All Implemented Interfaces:
java.io.Serializable

public class DKRouteListEntryICM
extends java.lang.Object
implements java.io.Serializable

The DKRouteListEntry class defines a route within a process. A route is defined to have a "From" work node (source), a "To" work node (destination) and a selection (a description) of this route). In general, a source worknode can have more than one branch emanating outwards from it (destination work nodes). The route list entry "Selection" is used to determine which destination a specific process instance will go from each work node. In other words, route list entries are used to provide "branching" functionality. A process object contains a collection of route list entry objects.

See Also:
DKProcessICM, Serialized Form

Constructor Summary
DKRouteListEntryICM()
          Default constructor for a route list entry object.
 
Method Summary
 DKRouteListEntryExtICM getExtension()
          Retrieves a reference to the extension object associated with this route list entry object.
 java.lang.String getFrom()
          Retrieves the name of the source node for this route list entry object.
 java.lang.String getSelection()
          Retrieves the value of the selection for this route list entry.
 java.lang.String getTo()
          Retrieves the name of the destination node for this route list entry object.
 void setExtension(DKRouteListEntryExtICM ext)
          Sets the extension object associated with this route list entry object.
 void setFrom(java.lang.String from)
          Sets the name of the source node for this route list entry object.
 void setSelection(java.lang.String selection)
          Sets the selection value for this route list entry.Each route list entry is associated with a selection that defines a transition in the associated process.
 void setTo(java.lang.String to)
          Sets the name of the destination node for this route list entry object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKRouteListEntryICM

public DKRouteListEntryICM()
Default constructor for a route list entry object. Constructs and initializes a route list entry instance.
  DKRouteListEntryICM route = new DKRouteListEntryICM();
  
See Also:
DKProcessICM
Method Detail

getFrom

public java.lang.String getFrom()
Retrieves the name of the source node for this route list entry object.
Returns:
the name of the source node for this route list entry object

setFrom

public void setFrom(java.lang.String from)
Sets the name of the source node for this route list entry object.
Parameters:
from - the name of the source node for this route list entry object

getTo

public java.lang.String getTo()
Retrieves the name of the destination node for this route list entry object.
Returns:
the name of the destination node for this route list entry object

setTo

public void setTo(java.lang.String to)
Sets the name of the destination node for this route list entry object.
Parameters:
to - the name of the destination node for this route list entry object

getSelection

public java.lang.String getSelection()
Retrieves the value of the selection for this route list entry. Each route list entry is associated with a selection that defines a transition in the associated process. The selection is a string value that defines the action that leads to a transition
Returns:
the value of the selection for this route list entry object as a string

setSelection

public void setSelection(java.lang.String selection)
Sets the selection value for this route list entry.Each route list entry is associated with a selection that defines a transition in the associated process. The selection is a string value that defines the action that leads to a transition
Parameters:
selection - the selection value associated with this route list entry object

setExtension

public void setExtension(DKRouteListEntryExtICM ext)
Sets the extension object associated with this route list entry object.
Parameters:
ext - a route list entry extension object as an instance of DKRouteListEntryExtICM to be associated with this route list entry object. A DKRouteListEntryExtICM contains a collection of name-value pairs as instances of DKNVPair, each of which has a name as a user-defined attribute name and a value as the corresponding user-defined attribute value for this route list entry object.
See Also:
DKRouteListEntryExtICM

getExtension

public DKRouteListEntryExtICM getExtension()
Retrieves a reference to the extension object associated with this route list entry object.
Returns:
the route list entry extension as an instance of DKRouteListEntryExtICM associated with this route list entry object, A DKRouteListEntryExtICM object contains a collection of name-value pairs as instances of DKNVPair, each of which has a name as a user-defined attribute name and a value as the corresponding user-defined attribute value for this route list entry object.
See Also:
DKRouteListEntryExtICM

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.