com.ibm.pim.extensionpoints
Interface CMSEntryBuildFunctionArguments


public interface CMSEntryBuildFunctionArguments

Interface defining the arguments passed to CMSEntryBuildFunction invocations.

Since:
9.0.0

Method Summary
 Category getCategory()
          Obtains the category entry being processed for this CMSEntryBuildFunction.
 com.ibm.pim.integration.CMSInstance getCMSInstanceObj()
          Obtains the CMS Instance object being processed for this CMSEntryBuildFunction.
 java.util.Map<java.lang.String,java.lang.String> getCMSMetaData()
          Obtains the map of metadata attributes and values being processed for this CMSEntryBuildFunction.
 java.util.Map<java.lang.String,java.lang.String> getCMSReadOnlyAttribs()
          Obtains the map of read only metadata attributes being processed for this CMSEntryBuildFunction.
 CollaborationCategory getCollaborationCategory()
          Obtains the collaboration category entry being processed for this CMSEntryBuildFunction.
 CollaborationItem getCollaborationItem()
          Obtains the collaboration item entry being processed for this CMSEntryBuildFunction.
 java.io.PrintWriter getErrors()
          Obtains access to the writer for error output created by this invocation.
 Item getItem()
          Obtains the item entry being processed for this CMSEntryBuildFunction.
 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.
 

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.

getCategory

Category getCategory()
Obtains the category entry being processed for this CMSEntryBuildFunction. Category

null if invocation is processing an Item


getItem

Item getItem()
Obtains the item entry being processed for this CMSEntryBuildFunction. Item

null if invocation is processing a Category


getCollaborationItem

CollaborationItem getCollaborationItem()
Obtains the collaboration item entry being processed for this CMSEntryBuildFunction. CollaborationItem

null if invocation is processing a Category


getCollaborationCategory

CollaborationCategory getCollaborationCategory()
Obtains the collaboration category entry being processed for this CMSEntryBuildFunction. CollaborationCategory

null if invocation is processing an Item


getCMSMetaData

java.util.Map<java.lang.String,java.lang.String> getCMSMetaData()
Obtains the map of metadata attributes and values being processed for this CMSEntryBuildFunction.


getCMSReadOnlyAttribs

java.util.Map<java.lang.String,java.lang.String> getCMSReadOnlyAttribs()
Obtains the map of read only metadata attributes being processed for this CMSEntryBuildFunction.


getCMSInstanceObj

com.ibm.pim.integration.CMSInstance getCMSInstanceObj()
Obtains the CMS Instance object being processed for this CMSEntryBuildFunction. CMSInstance