|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CatalogExportFunctionArguments
Interface defining the arguments passed to Catalog Export Function invocations.
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. |
Field Detail |
---|
static final java.lang.String copyright
Method Detail |
---|
PIMWriter getOutput()
PIMWriter getErrors()
PIMWriter getWarnings()
ScriptStatistics getScriptStats()
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.
java.lang.String getCharset()
Catalog getCatalog()
Hierarchy getHierarchy()
PIMCollection<Item> getItems()
VersionInfo getStartVersion()
VersionInfo getEndVersion()
CatalogExportFunctionArguments.CatalogExportDiffStatus getDiffStatus()
PIMProgress getProgress()
java.lang.String getOriginalDocFolder()
java.lang.Boolean getBypassApprovalWorkflow()
SpecMap getSpecMap()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |