com.ibm.pim.extensionpoints
Interface CatalogExportFunctionArguments

All Superinterfaces:
FunctionArguments

public interface CatalogExportFunctionArguments
extends FunctionArguments

Interface defining the arguments passed to Catalog Export Function invocations.

Since:
6.0.0

Nested Class Summary
static interface CatalogExportFunctionArguments.CatalogExportDiffStatus
           
 
Field Summary
static java.lang.String copyright
           
 
Method Summary
 java.lang.Boolean getBypassApprovalWorkflow()
          Obtains the default state of the bypass approval workflow flag for this CatalogExportFunction.
 Catalog getCatalog()
          Obtains the catalog being exported by this CatalogExportFunction.
 java.lang.String getCharset()
          Obtains the charset in effect for this CatalogExportFunction.
 CatalogExportFunctionArguments.CatalogExportDiffStatus getDiffStatus()
          Obtains the diff status being processed for this CatalogExportFunction.
 VersionInfo getEndVersion()
          Obtains the end version for this export.
 PIMWriter getErrors()
          Obtains access to the writer for error output created by this CatalogExportFunction.
 Hierarchy getHierarchy()
          Obtains the hierarchy for the catalog of this CatalogExportFunction.
 PIMCollection<Item> getItems()
          Obtains the items being processed for this CatalogExportFunction.
 java.lang.String getOriginalDocFolder()
          Obtains the path within the docstore where output is created as part of this CatalogExportFunction.
 PIMWriter getOutput()
          Obtains access to the writer for output created by this CatalogExportFunction.
 PIMProgress getProgress()
          Obtain the instance of WPCProgress that may be used to report progress to WPC during the execution of this CatalogExportFunction.
 ScriptStatistics getScriptStats()
          Obtains the script stats being processed for this CatalogExportFunction.
 SpecMap getSpecMap()
          Obtains the SpecMap for this invocation.
 VersionInfo getStartVersion()
          Obtains the start version for this export.
 PIMWriter getWarnings()
          Obtains access to the writer for warning output created by this CatalogExportFunction.
 
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

PIMWriter getOutput()
Obtains access to the writer for output created by this CatalogExportFunction.

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

getErrors

PIMWriter getErrors()
Obtains access to the writer for error output created by this CatalogExportFunction.

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

getWarnings

PIMWriter getWarnings()
Obtains access to the writer for warning output created by this CatalogExportFunction.

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

getScriptStats

ScriptStatistics getScriptStats()
Obtains the script stats being processed for this CatalogExportFunction.

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 CatalogExportFunction to provide this feedback for users.

Equivalent in Script API:
The statistics were previously updated implicitly by the actions performed via the scripting API.

getCharset

java.lang.String getCharset()
Obtains the charset in effect for this CatalogExportFunction.


getCatalog

Catalog getCatalog()
Obtains the catalog being exported by this CatalogExportFunction.


getHierarchy

Hierarchy getHierarchy()
Obtains the hierarchy for the catalog of this CatalogExportFunction.


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.

getStartVersion

VersionInfo getStartVersion()
Obtains the start version for this export.


getEndVersion

VersionInfo getEndVersion()
Obtains the end version for this export.


getDiffStatus

CatalogExportFunctionArguments.CatalogExportDiffStatus getDiffStatus()
Obtains the diff status being processed for this CatalogExportFunction.


getProgress

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

Equivalent in Script API:
provides function available in script via 'setScriptProgress'

getOriginalDocFolder

java.lang.String getOriginalDocFolder()
Obtains the path within the docstore where output is created as part of this CatalogExportFunction.


getBypassApprovalWorkflow

java.lang.Boolean getBypassApprovalWorkflow()
Obtains the default state of the bypass approval workflow flag for this CatalogExportFunction. The invocation can signal a new state for this flag as the return from the function invocation.


getSpecMap

SpecMap getSpecMap()
Obtains the SpecMap for this invocation.