|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ExportAction
Export Action provides the ability to export CSROs into an export archive which could be imported into another CentraSite.
This action can be applied to multiple CSROs.
You can use the ExportOption
to configure your exports.
This action includes the states "Initial", "Export Preview" and "Completed" as in the following hierarchical flow:
Initial -> Export Preview -> Completed
Possible State Transitions are (Read as FROM STATE --> TO STATE (Action)):
1) INITIAL --> EXPORT PREVIEW (Execute Next Step)
2) INITIAL --> COMPLETED (Finish All Steps)
3) INITIAL --> COMPLETED (Cancel)
4) EXPORT PREVIEW -> COMPLETED (Execute Next Step)
5) EXPORT PREVIEW --> COMPLETED (Finish All Steps)
6) EXPORT PREVIEW --> COMPLETED (Cancel)
Method Summary | |
---|---|
java.util.Collection<ExportOption> |
getApplicableExportOptions()
return available export options based on the objects set for the export action. |
java.io.InputStream |
getExportArchive()
Get the export archive content as stream. |
java.util.Map<CentraSiteObject,java.lang.String> |
getExportLogMessages()
Get the logs for the export. |
java.util.Map<CentraSiteRegistryObject,java.util.Collection<CentraSiteRegistryObject>> |
getExportPreview()
Returns the preview of the export in the form of a map. |
java.lang.String |
getFileName()
Returns the zip file name used to create the zip file |
int |
getProcessedObjectsCount()
Get the number of processed in the process of exported action(i.e this count is cumulative of exported successfully, exported with warnings, export failed objects count ) |
int |
getTotalObjectsCount()
total number of objects identified for export(i.e this count is cumulative of top level objects and it dependent objects also) |
java.util.Collection<ExportOption> |
getUserSelectedExportOptions()
Get the collection of export options relevant for the objects specified in setObjects(). |
boolean |
isPreviewComplete()
|
void |
removeExportOptions(java.util.Collection<ExportOption> exportOptions)
Remove the options for export |
void |
setExcludedObjects(java.util.Collection<CentraSiteRegistryObject> objectsToBeExcluded)
Specify the collection of object(s) which will be excluded from the export archive. |
void |
setPreviewComplete(boolean isPreviewComplete)
used to set to true in case of preview options is finalized. |
void |
setUserSelectedExportOptions(java.util.Collection<ExportOption> exportOptions)
Set the options for export |
Methods inherited from interface com.softwareag.centrasite.api.csom.action.CSOAction |
---|
cancel, executeNextStep, executePreviousStep, finishAllSteps, getCurrentState, getGroup, getIconURL, getId, getName, getSkippedObjectsWithReason, isAllowed, isApplicable, setObjects |
Method Detail |
---|
java.util.Map<CentraSiteRegistryObject,java.util.Collection<CentraSiteRegistryObject>> getExportPreview() throws CLLException
CLLException
void setExcludedObjects(java.util.Collection<CentraSiteRegistryObject> objectsToBeExcluded) throws CLLException
objectsToBeExcluded
-
CLLException
java.util.Collection<ExportOption> getUserSelectedExportOptions() throws CLLException
CLLException
void setUserSelectedExportOptions(java.util.Collection<ExportOption> exportOptions) throws CLLException
exportOptions
- Collection of ExportOption
CLLException
void removeExportOptions(java.util.Collection<ExportOption> exportOptions)
exportOptions
- java.io.InputStream getExportArchive() throws CLLException
CLLException
java.util.Map<CentraSiteObject,java.lang.String> getExportLogMessages() throws CLLException
CLLException
int getProcessedObjectsCount()
int getTotalObjectsCount()
java.lang.String getFileName()
void setPreviewComplete(boolean isPreviewComplete)
isPreviewComplete
- true - in case of user finalized the preview options other
wise false.boolean isPreviewComplete()
java.util.Collection<ExportOption> getApplicableExportOptions() throws CLLException
CLLException
- in case of failed to get the applicable export options.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |