com.ibm.pim.extensionpoints
Interface WorkflowStepFunctionArguments


public interface WorkflowStepFunctionArguments

Interface defining the arguments passed to WorkflowStepFunction invocations.

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 PIMCollection<CollaborationCategory> getCategories()
          Obtains the set of Category entries being processed for this WorkflowStepFunction.
 CollaborationStep getCollaborationStep()
          Obtains the collaboration step relevant to the entries being processed within this invocation.
 PIMCollection<CollaborationItem> getItems()
          Obtains the set of Item entries being processed for this WorkflowStepFunction.
 CollaborationStepTransitionConfiguration getTransitionConfiguration()
          Obtain the mapping of entries to exit values for this invocation.
 

Field Detail

copyright

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

getItems

PIMCollection<CollaborationItem> getItems()
Obtains the set of Item entries being processed for this WorkflowStepFunction.

Will be null if this invocation is processing categories.


getCategories

PIMCollection<CollaborationCategory> getCategories()
Obtains the set of Category entries being processed for this WorkflowStepFunction.

Will be null if this invocation is processing items.


getCollaborationStep

CollaborationStep getCollaborationStep()
Obtains the collaboration step relevant to the entries being processed within this invocation.


getTransitionConfiguration

CollaborationStepTransitionConfiguration getTransitionConfiguration()
Obtain the mapping of entries to exit values for this invocation.

Exit values for an entry may be queried or altered via manipulation of the returned object.