com.ibm.pim.extensionpoints
Interface CatalogPreviewFunctionArguments


public interface CatalogPreviewFunctionArguments

Interface defining the arguments passed to CatalogPreviewFunction invocations.

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 Catalog getCatalog()
          Obtains the catalog being processed for this CatalogPreviewFunction.
 java.io.PrintWriter getErrors()
          Obtains access to the writer for error output created by this invocation.
 PIMCollection<Item> getItems()
          Obtains the items being processed for this CatalogPreviewFunction.
 java.io.PrintWriter getOutput()
          Obtains access to the writer for output created by this invocation.
 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.

This is the writer that should be used to write the content that will be used as the 'preview'.

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.

getCatalog

Catalog getCatalog()
Obtains the catalog being processed for this CatalogPreviewFunction.


getItems

PIMCollection<Item> getItems()
Obtains the items being processed for this CatalogPreviewFunction.

Equivalent in Script API:
Equivalent to the use of the script operation 'ForEachCtgItem' with no catalog name.