com.ibm.pim.extensionpoints
Interface ImportFunctionArguments

All Superinterfaces:
FunctionArguments

public interface ImportFunctionArguments
extends FunctionArguments

Interface defining the arguments passed to ImportFunction invocations.

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 Catalog getCatalog()
          Obtains the catalog being processed for this ImportFunction.
 java.lang.String getCatalogDelimiter()
          Obtains the catalog delimiter being processed for this ImportFunction.
 CollaborationArea getCollaborationArea()
          Obtains the collaboration area being processed for this ImportFunction.
 long getContentLength()
          Obtains the content length being processed for this ImportFunction.
 Document getDocstoreDataDoc()
          Obtains the data document from the docstore being processed for this ImportFunction.
 PIMWriter getErrors()
          Obtains access to the writer for error output created by this ImportFunction.
 Hierarchy getHierarchy()
          Obtains the category tree being processed for this ImportFunction.
 java.io.Reader getInput()
          Obtains the input stream being processed for this ImportFunction.
 java.util.Map getInputs()
          Obtains the input arguments, if defined
 java.io.PrintWriter getOutput()
          Obtains access to the writer for output created by this ImportFunction.
 PIMProgress getProgress()
          Obtain the instance of WPCProgress that may be used to report progress to WPC during the execution of this ImportFunction.
 ScriptStatistics getScriptStats()
          Obtains the script stats being processed for this ImportExportFunction.
 SpecMap getSpecMap()
          Obtains the SpecMap for this invocation.
 PIMWriter getWarnings()
          Obtains access to the writer for warning output created by this ImportFunction.
 java.lang.String getWorkflowStepPath()
          Obtains the workflow step path being processed for this ImportFunction.
 
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 ImportFunction.

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 ImportFunction.

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 ImportFunction.

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

getProgress

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


getScriptStats

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


getWorkflowStepPath

java.lang.String getWorkflowStepPath()
Obtains the workflow step path being processed for this ImportFunction.

Will be null if not processing import within a workflow


getCollaborationArea

CollaborationArea getCollaborationArea()
Obtains the collaboration area being processed for this ImportFunction.

Will be null if not processing import within a workflow


getCatalog

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

Will be null if processing an import within a workflow.


getHierarchy

Hierarchy getHierarchy()
Obtains the category tree being processed for this ImportFunction.

Will be null if this import is a binary, or item feed.


getCatalogDelimiter

java.lang.String getCatalogDelimiter()
Obtains the catalog delimiter being processed for this ImportFunction.

Will be null if this import is a binary, or item feed.


getInput

java.io.Reader getInput()
Obtains the input stream being processed for this ImportFunction.


getContentLength

long getContentLength()
Obtains the content length being processed for this ImportFunction.


getDocstoreDataDoc

Document getDocstoreDataDoc()
Obtains the data document from the docstore being processed for this ImportFunction.


getSpecMap

SpecMap getSpecMap()
Obtains the SpecMap for this invocation.


getInputs

java.util.Map getInputs()
Obtains the input arguments, if defined