com.ibm.pim.extensionpoints
Interface CollaborationItemPrePostProcessingFunctionArguments

All Superinterfaces:
FunctionArguments

public interface CollaborationItemPrePostProcessingFunctionArguments
extends FunctionArguments

Interface defining the arguments passed to PrePostProcessingFunction invocations.

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 void addValidationError(AttributeInstance ai, ValidationError.Type errorType, java.lang.String errorMessage)
          Adds a validation error, constructed from the error type and error message, to the given attribute instance.
 CollaborationItem getCollaborationItem()
          Obtains the item to be processed by this pre/post function.
 CollaborationStep getCollaborationStep()
          Obtains the collaboration step for this RuleFunction.
 java.io.PrintWriter getErrors()
          Obtains access to the writer for error output created by this invocation.
 java.lang.String getExitValueForItem()
          Obtains the exitValue for a workflow item, Returns the name of the exit value which was selected to move the workflow to another step.
 java.io.PrintWriter getOutput()
          Obtains access to the writer for output created by this invocation.
 ValidationErrors getValidationErrors()
          Obtains the validation errors for this item.
 java.io.PrintWriter getWarnings()
          Obtains access to the writer for warning output created by this invocation.
 
Methods inherited from interface com.ibm.pim.extensionpoints.FunctionArguments
getCustomParameter, setCustomParameter
 

Field Detail

copyright

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

getOutput

java.io.PrintWriter getOutput()
Obtains access to the writer for output created by this invocation.

Equivalent in Script API:
Equivalent to the script 'out' writer within the corresponding type of script.

getErrors

java.io.PrintWriter getErrors()
Obtains access to the writer for error output created by this invocation.

Equivalent in Script API:
Equivalent to the script 'err' writer within the corresponding type of script.

getWarnings

java.io.PrintWriter getWarnings()
Obtains access to the writer for warning output created by this invocation.

Equivalent in Script API:
Equivalent to the script 'wrn' writer within the corresponding type of script.

getCollaborationItem

CollaborationItem getCollaborationItem()
Obtains the item to be processed by this pre/post function.


getValidationErrors

ValidationErrors getValidationErrors()
Obtains the validation errors for this item.


getCollaborationStep

CollaborationStep getCollaborationStep()
Obtains the collaboration step for this RuleFunction.


addValidationError

void addValidationError(AttributeInstance ai,
                        ValidationError.Type errorType,
                        java.lang.String errorMessage)
Adds a validation error, constructed from the error type and error message, to the given attribute instance.


getExitValueForItem

java.lang.String getExitValueForItem()
Obtains the exitValue for a workflow item, Returns the name of the exit value which was selected to move the workflow to another step.