|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EnvironmentExporter
This interface defines methods for PIM system environment export.
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 |
---|
static final java.lang.String copyright
Method Detail |
---|
ExportList createExportList()
PIMInternalException
- if an internal error occursjava.lang.String export(ExportList exportList, java.lang.String documentPath)
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.
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 stringexport(ExportList, String, boolean)
java.lang.String export(ExportList exportList, java.lang.String documentPath, boolean checkForRequisites)
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 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 stringjava.lang.String exportAll(java.lang.String documentPath)
documentPath
- The docstore path at which the generated zip file has to be
stored. Any file existing at this path will be overwritten.
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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |