|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DownloadDocumentAction
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 |
---|
boolean includeSupportingDocuments()
CentraSiteRegistryObject
can be included for download.
Boolean.TRUE
if the supporting document associated with CentraSiteRegistryObject
can be included for download; else Boolean.FALSE
.void setIncludeSupportingDocuments(boolean isIncludeSuptDoc)
CentraSiteRegistryObject
to be included or excluded for download.
isIncludeSuptDoc
- Either - Boolean.TRUE
to indicate if the supporting documents associated with
CentraSiteRegistryObject
can be included for download. Boolean.FALSE
- to indicate if the supporting documents associated with 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
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |