public interface ExportAction extends CSOAction
ExportOption
to configure your exports. Modifier and Type | Method and Description |
---|---|
java.util.Collection<ExportOption> |
getApplicableExportOptions()
Return the 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 objects in the process of exported action.
|
int |
getTotalObjectsCount()
Total number of objects identified for export (i.e this count is
cumulative of top level objects and its dependent objects also).
|
java.util.Collection<ExportOption> |
getUserSelectedExportOptions()
Gets the collection of export options relevant for the objects specified in setObjects().
|
boolean |
isPreviewComplete()
Checks if the preview is complete or not.
|
void |
removeExportOptions(java.util.Collection<ExportOption> exportOptions)
Remove the options set 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 the preview options are finalized.
|
void |
setUserSelectedExportOptions(java.util.Collection<ExportOption> exportOptions)
Sets the options for export.
|
cancel, doesLoggedInUserHaveSufficientRolesOrPermissions, executeNextStep, executePreviousStep, finishAllSteps, getCurrentState, getGroup, getIconURL, getId, getName, getNonApplicableReason, getSkippedObjectsWithReason, isAllowed, isApplicable, setObjects
java.util.Map<CentraSiteRegistryObject,java.util.Collection<CentraSiteRegistryObject>> getExportPreview() throws CLLException
Map
containing the root objects (initial objects on which the export is performed) as keys and their dependents as values.CLLException
- If an error occurs while trying to collect all the exported objectsvoid setExcludedObjects(java.util.Collection<CentraSiteRegistryObject> objectsToBeExcluded) throws CLLException
objectsToBeExcluded
- A Collection
specifying the CentraSiteRegistryObject
s which should be excludedCLLException
- If CLL fails to set the excluded objectsjava.util.Collection<ExportOption> getUserSelectedExportOptions() throws CLLException
Collection
of ExportOption
s set by the userCLLException
- If CLL fails to get the export optionsvoid setUserSelectedExportOptions(java.util.Collection<ExportOption> exportOptions) throws CLLException
exportOptions
- Collection
of ExportOption
s to setCLLException
- If CLL fails to set the export optionsvoid removeExportOptions(java.util.Collection<ExportOption> exportOptions)
exportOptions
- The Collection
of ExportOption
s to removejava.io.InputStream getExportArchive() throws CLLException
InputStream
of the archiveCLLException
- If CLL fails to get the content streamjava.util.Map<CentraSiteObject,java.lang.String> getExportLogMessages() throws CLLException
Map
containing the exported objects as keys and the export messages as valuesCLLException
- If CLL fails to get the export log messagesint getProcessedObjectsCount()
int getTotalObjectsCount()
java.lang.String getFileName()
void setPreviewComplete(boolean isPreviewComplete)
isPreviewComplete
- true - in case the user finalized the preview options otherwise false.boolean isPreviewComplete()
java.util.Collection<ExportOption> getApplicableExportOptions() throws CLLException
Collection
of options applicable for objects set for the export.CLLException
- In case of failed to get the applicable export options.