public interface DownloadDocumentAction extends CSOAction
CentraSiteObject
. CentraSiteRegistryObject
.Modifier and Type | Method and Description |
---|---|
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
that 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. |
cancel, doesLoggedInUserHaveSufficientRolesOrPermissions, executeNextStep, executePreviousStep, finishAllSteps, getCurrentState, getGroup, getIconURL, getId, getName, getSkippedObjectsWithReason, isAllowed, isApplicable, setObjects
boolean includeSupportingDocuments()
CentraSiteRegistryObject
that can be included for download.CentraSiteRegistryObject
can be included for download; else false.void setIncludeSupportingDocuments(boolean isIncludeSuptDoc)
CentraSiteRegistryObject
to be included or excluded for download.isIncludeSuptDoc
- Either - true to indicate if the supporting documents associated with
CentraSiteRegistryObject
can be included for download. CentraSiteRegistryObject
can be excluded for download.java.io.InputStream getDownloadContent() throws CLLException
CentraSiteRegistryObject
documents as InputStream.CLLException
- in case if there is no file available for download.java.lang.String getFileName() throws CLLException
CLLException
- if the action is not completed