|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EnvironmentImporter
This interface defines methods for PIM system environment import
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 |
---|
static final java.lang.String copyright
Method Detail |
---|
java.lang.String importEnvironment(Document document)
document
- A document in the docstore. This document should be a zip
file, otherwise an exception will be thrown.
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 nulljava.lang.String importEnvironment(java.lang.String documentPath)
documentPath
- The path of the file in the file system.
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 stringImportList getImportList(Document document)
document
- The document in the docstore.
PIMInternalException
- If an internal error occurs.
java.lang.IllegalArgumentException
- If document is null or if the document is not a zip fileImportList getImportList(java.lang.String documentPath)
documentPath
- The file system path of the zip file.
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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |