com.ibm.pim.extensionpoints
Interface CategoryPrePostProcessingFunctionArguments


public interface CategoryPrePostProcessingFunctionArguments

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.
 Category getCategory()
          Obtains the category to be processed by this pre/post function.
 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.

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.

getCategory

Category getCategory()
Obtains the category to be processed by this pre/post function.


getValidationErrors

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


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.