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

All Superinterfaces:
CSOAction

public interface DownloadDocumentAction
extends CSOAction

The DownloadDocumentAction provides the capability to download the documents associated with CentraSiteObject .
This includes all dependent asset documents and optionally any supporting documents associated with the CentraSiteRegistryObject.


Method Summary
 java.io.InputStream getDownloadContent()
          Returns the binary download content for the zip file containing the CentraSiteRegistryObject documents as InputStream.
 java.lang.String getFileName()
          Returns the zip file name for download
 boolean includeSupportingDocuments()
          Returns if the supporting documents associated with the CentraSiteRegistryObject can be included for download.
 void setIncludeSupportingDocuments(boolean isIncludeSuptDoc)
          Allow or disallow supporting documents associated with the CentraSiteRegistryObject to be included or excluded for download.
 
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

includeSupportingDocuments

boolean includeSupportingDocuments()
Returns if the supporting documents associated with the CentraSiteRegistryObject can be included for download.

Returns:
Boolean.TRUE if the supporting document associated with CentraSiteRegistryObject can be included for download; else Boolean.FALSE.

setIncludeSupportingDocuments

void setIncludeSupportingDocuments(boolean isIncludeSuptDoc)
Allow or disallow supporting documents associated with the CentraSiteRegistryObject to be included or excluded for download.

Parameters:
isIncludeSuptDoc - Either - Boolean.TRUE to indicate if the supporting documents associated with CentraSiteRegistryObject can be included for download.
Else, Boolean.FALSE - to indicate if the supporting documents associated with CentraSiteRegistryObject can be excluded for download.

getDownloadContent

java.io.InputStream getDownloadContent()
                                       throws CLLException
Returns the binary download content for the zip file containing the CentraSiteRegistryObject documents as InputStream.

Returns:
the binary download content for the zip file.
Throws:
CLLException - in case if there is no file available for download.

getFileName

java.lang.String getFileName()
                             throws CLLException
Returns the zip file name for download

Returns:
downloaded file name
Throws:
CLLException - if the action is not completed