com.ibm.pim.utils
Interface EnvironmentImporter


public interface EnvironmentImporter

This interface defines methods for PIM system environment import

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 ImportList getImportList(Document document)
          Gets the list of PIM objects in a zip file in the docstore.
 ImportList getImportList(java.lang.String documentPath)
          Gets the list of PIM objects in a zip file present at the specified documentPath.
 java.lang.String importEnvironment(Document document)
          Imports a document in zip format into the company.
 java.lang.String importEnvironment(java.lang.String documentPath)
          Imports a zip file in the file system into the company.
 

Field Detail

copyright

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

importEnvironment

java.lang.String importEnvironment(Document document)
Imports a document in zip format into the company. The zip file has to be created using the environment export tool.

Parameters:
document - A document in the docstore. This document should be a zip file, otherwise an exception will be thrown.
Returns:
The import log as a String
Throws:
PIMInternalException - If an internal error occurs or the document passed in as a parameter is not a zip file
PIMAuthorizationException - Reserved for future use
java.lang.IllegalArgumentException - If document is null

importEnvironment

java.lang.String importEnvironment(java.lang.String documentPath)
Imports a zip file in the file system into the company. The zip file has to be created using the environment export tool.

Parameters:
documentPath - The path of the file in the file system.
Returns:
The import 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

getImportList

ImportList getImportList(Document document)
Gets the list of PIM objects in a zip file in the docstore. The zip file should have been created using the environment export tool.

Parameters:
document - The document in the docstore.
Returns:
An ImportList object listing objects in the zip file.
Throws:
PIMInternalException - If an internal error occurs.
java.lang.IllegalArgumentException - If document is null or if the document is not a zip file

getImportList

ImportList getImportList(java.lang.String documentPath)
Gets the list of PIM objects in a zip file present at the specified documentPath. The zip file should have been created using the environment export tool.

Parameters:
documentPath - The file system path of the zip file.
Returns:
An ImportList object listing objects in the zip file.
Throws:
PIMInternalException - If an internal error occurs
java.lang.IllegalArgumentException - If the documentPath is null or if the documentPath is an empty string or if the file is not a zip file