com.ibm.pim.extensionpoints
Interface CollaborationCategoryRunValueRuleFunctionArguments


public interface CollaborationCategoryRunValueRuleFunctionArguments

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 void addValidationError(ValidationError.Type errorType, java.lang.String errorMessage)
          Adds a validation error, constructed from the given error type and error message, to the attribute instance for this rule function.
 AttributeInstance getAttributeInstance()
          Obtains the attribute instance for this RuleFunction.
 CollaborationCategory getCollaborationCategory()
          Obtains the category to be processed by this rule 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.io.PrintWriter getOutput()
          Obtains access to the writer for output created by this invocation.
 ValidationErrors getValidationErrors()
          Obtains the validation errors for this category.
 java.io.PrintWriter getWarnings()
          Obtains access to the writer for warning output created by this invocation.
 

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.

Output written to the error writer is used to create a ValidationError for the AttributeInstance if an error occurs during processing.

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.

getCollaborationCategory

CollaborationCategory getCollaborationCategory()
Obtains the category to be processed by this rule function.


getValidationErrors

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


getAttributeInstance

AttributeInstance getAttributeInstance()
Obtains the attribute instance for this RuleFunction.


getCollaborationStep

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


addValidationError

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