com.ibm.pim.utils
Interface EnvironmentExporter


public interface EnvironmentExporter

This interface defines methods for PIM system environment export.

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 ExportList createExportList()
          Returns a container(ExportList) to hold the names of PIM objects to be exported.
 java.lang.String export(ExportList exportList, java.lang.String documentPath)
          Exports the PIM objects specified in the ExportList in zip format and stores the file at the docstore file path specified.
 java.lang.String export(ExportList exportList, java.lang.String documentPath, boolean checkForRequisites)
          Exports the PIM objects specified in the ExportList in zip format and stores the file at the docstore file path specified.
 java.lang.String exportAll(java.lang.String documentPath)
          Exports all the objects in the company in CREATE_OR_UPDATE mode
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

createExportList

ExportList createExportList()
Returns a container(ExportList) to hold the names of PIM objects to be exported.

Returns:
An ExportList object.
Throws:
PIMInternalException - if an internal error occurs

export

java.lang.String export(ExportList exportList,
                        java.lang.String documentPath)
Exports the PIM objects specified in the ExportList in zip format and stores the file at the docstore file path specified. Returns the log for this operation as a String. This method ignores the dependency check between objects.

Parameters:
exportList - The list containing the names of PIM objects to be exported.
documentPath - The docstore path where the generated zip file has to be stored. Any file existing at this path will be overwritten.
Returns:
The log message as a String.
Throws:
PIMInternalException - if an internal error occurs
PIMAuthorizationException - Reserved for future use
java.lang.IllegalArgumentException - If exportList is null or documentPath is null or if the documentPath is an empty string
See Also:
export(ExportList, String, boolean)

export

java.lang.String export(ExportList exportList,
                        java.lang.String documentPath,
                        boolean checkForRequisites)
Exports the PIM objects specified in the ExportList in zip format and stores the file at the docstore file path specified. Returns the log for this operation as a String. The checkForRequisites parameter determines whether a check for required objects has to performed. When this parameter is true, a PIMInternalException is thrown, when the list of objects to be exported are dependent on objects which are not in the list.

Parameters:
exportList - The container object which contains the information about the PIM objects which are to be exported.
documentPath - The docstore path where the generated zip file has to be stored. Any file existing at this path will be overwritten.
checkForRequisites - When this parameter is true, the export method first checks whether all the objects
that the objects on the ExportList require, are part of the ExportList. This is to
ensure that the zip file created can be imported successfully in the target environment.
When objects in the list require objects that are not part of the list, a PIMInternalException
is thrown. For example, Consider Catalog Ctg has been created using Spec Spec1 and Hierarchy
Hierarchy1. If the export list contains the Catalog Ctg and does not contain Spec1 and Hierarchy1,
this method throws a PIMInternalException, because in a newly created company, or in a company
that does not contain Spec1 and Hiearchy1, import of the zip file generated by this method will fail.
Returns:
The export log as a String.
Throws:
PIMInternalException - if an internal error occurs or when the list of objects to be exported are dependent on objects that are not in the export list. User can invoke ExportList.getRequisites() on the ExportList to get a list of objects which the objects in the list need for successful creation at the target environment. export(ExportList exportList, String documentPath) ignores the dependency check.
PIMAuthorizationException - Reserved for future use
java.lang.IllegalArgumentException - If exportList is null or documentPath is null or if the documentPath is an empty string

exportAll

java.lang.String exportAll(java.lang.String documentPath)
Exports all the objects in the company in CREATE_OR_UPDATE mode

Parameters:
documentPath - The docstore path at which the generated zip file has to be stored. Any file existing at this path will be overwritten.
Returns:
The export log as a String.
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use
java.lang.IllegalArgumentException - If the documentPath is null or if the documentPath is an empty string