com.ibm.pim.collaboration
Interface CollaborationStepTransitionConfiguration


public interface CollaborationStepTransitionConfiguration

The interface CollaborationStepTransitionConfiguration represents a configuration for the transition of one or more collaboration objects moving together on a particular exit value out of a collaboration step.

It exists to allow the user to alter the path of collaboration objects exiting a step.

It is accessible only in workflow step scripts, and cannot be constructed in other Java API programs.

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 ExitValue getDefaultExitValue()
          Gets the exit value on which the collaboration objects are expected to move out (that is, the exit value they were originally assigned).
 ExitValue getExitValue(CollaborationObject object)
          Gets the current exit value for the specified collaboration object.
 void removeFromTransition(CollaborationObject object)
          Removes the specified collaboration object from this transition, causing it to stay in its origin step.
 void setExitValue(CollaborationObject object, ExitValue newExitValue)
          Sets a new exit value for the specified collaboration object.
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

getDefaultExitValue

ExitValue getDefaultExitValue()
Gets the exit value on which the collaboration objects are expected to move out (that is, the exit value they were originally assigned).

Returns:
the exit value on which the collaboration objects are moving out.

getExitValue

ExitValue getExitValue(CollaborationObject object)
Gets the current exit value for the specified collaboration object.

Parameters:
object - the collaboration object whose current exit value is sought. This argument must not be null, and must refer to a collaboration object that is in this transition.
Returns:
the current exit value for the specified collaboration object. By default this will be the same as that returned by getDefaultExitValue, but will be different if the user has called setExitValue on that collaboration object.
Throws:
java.lang.IllegalArgumentException - if the specified collaboration object is null or is not in this transition.

setExitValue

void setExitValue(CollaborationObject object,
                  ExitValue newExitValue)
Sets a new exit value for the specified collaboration object.

Parameters:
object - the collaboration object whose exit value is to be set. This argument must not be null, and must refer to a collaboration object that is in this transition.
newExitValue - the new exit value for the specified collaboration object. This argument must not be null and must be a valid exit value for the origin collaboration step.
Throws:
java.lang.IllegalArgumentException - if the specified collaboration object is not in this transition, or if the specified exit value is not in the set of allowed exit values for this transition, or if either argument is null.

removeFromTransition

void removeFromTransition(CollaborationObject object)
Removes the specified collaboration object from this transition, causing it to stay in its origin step.

Parameters:
object - the collaboration object to be removed. This argument must not be null, and must refer to a collaboration object that is in this transition.
Throws:
java.lang.IllegalArgumentException - if the specified collaboration object is null or is not in this transition.