com.softwareag.centrasite.api.csom.action
Interface ExportAction

All Superinterfaces:
CSOAction

public interface ExportAction
extends CSOAction

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

getExportPreview

java.util.Map<CentraSiteRegistryObject,java.util.Collection<CentraSiteRegistryObject>> getExportPreview()
                                                                                                        throws CLLException
Returns the preview of the export in the form of a map.

Returns:
A map containing the root objects (initial objects on which the export is performed) as keys and their dependents as values.
Throws:
CLLException

setExcludedObjects

void setExcludedObjects(java.util.Collection<CentraSiteRegistryObject> objectsToBeExcluded)
                        throws CLLException
Specify the collection of object(s) which will be excluded from the export archive.

Parameters:
objectsToBeExcluded -
Throws:
CLLException

getUserSelectedExportOptions

java.util.Collection<ExportOption> getUserSelectedExportOptions()
                                                                throws CLLException
Get the collection of export options relevant for the objects specified in setObjects().

Returns:
exportOptions
Throws:
CLLException

setUserSelectedExportOptions

void setUserSelectedExportOptions(java.util.Collection<ExportOption> exportOptions)
                                  throws CLLException
Set the options for export

Parameters:
exportOptions - Collection of ExportOption
Throws:
CLLException

removeExportOptions

void removeExportOptions(java.util.Collection<ExportOption> exportOptions)
Remove the options for export

Parameters:
exportOptions -

getExportArchive

java.io.InputStream getExportArchive()
                                     throws CLLException
Get the export archive content as stream.

Returns:
inputstream of the archive
Throws:
CLLException

getExportLogMessages

java.util.Map<CentraSiteObject,java.lang.String> getExportLogMessages()
                                                                      throws CLLException
Get the logs for the export.

Returns:
A map containing the exported objects as keys and the export messages as values
Throws:
CLLException

getProcessedObjectsCount

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 )

Returns:
number of processed as part of exported action.

getTotalObjectsCount

int getTotalObjectsCount()
total number of objects identified for export(i.e this count is cumulative of top level objects and it dependent objects also)

Returns:
number of objects getting exported.

getFileName

java.lang.String getFileName()
Returns the zip file name used to create the zip file

Returns:
zip file name

setPreviewComplete

void setPreviewComplete(boolean isPreviewComplete)
used to set to true in case of preview options is finalized.

Parameters:
isPreviewComplete - true - in case of user finalized the preview options other wise false.

isPreviewComplete

boolean isPreviewComplete()

getApplicableExportOptions

java.util.Collection<ExportOption> getApplicableExportOptions()
                                                              throws CLLException
return available export options based on the objects set for the export action.

Returns:
list of options applicable for objects set for the export.
Throws:
CLLException - in case of failed to get the applicable export options.