com.ibm.pim.extensionpoints
Interface CatalogToCatalogExportFunctionArguments

All Superinterfaces:
FunctionArguments

public interface CatalogToCatalogExportFunctionArguments
extends FunctionArguments

Interface defining the arguments passed to CatalogToCatalogExportFunction invocations.

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 Catalog getDestinationCatalog()
          Obtains the destination catalog being processed for this CatalogToCatalogExportFunction.
 java.io.PrintWriter getErrors()
          Obtains access to the writer for error output created by this invocation.
 java.util.Map getInputs()
          Obtains the inputs for this CatalogToCatalogExportFunction .
 PIMCollection<Item> getItems()
          Obtains the items being processed for this CatalogExportFunction.
 java.io.PrintWriter getOutput()
          Obtains access to the writer for output created by this invocation.
 PIMProgress getProgress()
          Obtain the instance of WPCProgress that may be used to report progress to WPC during the execution of this CatalogToCatalogExportFunction.
 ScriptStatistics getScriptStats()
          Obtains the script stats being processed for this CatalogToCatalogExportFunction.
 Catalog getSourceCatalog()
          Obtains the source catalog being processed for this CatalogToCatalogExportFunction.
 SpecMap getSpecMap()
          Obtains the SpecMap for this invocation.
 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.

getInputs

java.util.Map getInputs()
Obtains the inputs for this CatalogToCatalogExportFunction .


getProgress

PIMProgress getProgress()
Obtain the instance of WPCProgress that may be used to report progress to WPC during the execution of this CatalogToCatalogExportFunction.


getScriptStats

ScriptStatistics getScriptStats()
Obtains the script stats being processed for this CatalogToCatalogExportFunction. ScriptStatistics are used to update the UI with information related to the result of processing the export function. The ScriptStatistics object should be updated appropriately by the implementor of a CatalogtoCatalogExportFunction to provide this feedback for users.


getSourceCatalog

Catalog getSourceCatalog()
Obtains the source catalog being processed for this CatalogToCatalogExportFunction.


getDestinationCatalog

Catalog getDestinationCatalog()
Obtains the destination catalog being processed for this CatalogToCatalogExportFunction.


getItems

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

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

getSpecMap

SpecMap getSpecMap()
Obtains the SpecMap for this invocation.