oracle.bpm.casemgmt

Interface ICaseDocumentStreamService

All Known Subinterfaces:

ICaseStreamService

public interface ICaseDocumentStreamService

This interface lists APIs related to case documents

Method Summary

Modifier and Type	Method and Description
java.io.InputStream	downloadDocument(IBPMContext context, CaseIdentifier caseIdentifier, java.lang.String docName) Download a document
java.io.InputStream	downloadDocumentById(IBPMContext context, CaseIdentifier caseIdentifier, java.lang.String docId) Download a document
boolean	uploadDocument(IBPMContext context, CaseIdentifier caseIdentifier, java.lang.String docName, java.lang.String mimeType, java.io.InputStream inputStream, java.lang.String comments, java.lang.String permissionTag) Upload a document

Method Detail

downloadDocument

java.io.InputStream downloadDocument(IBPMContext context,
                                     CaseIdentifier caseIdentifier,
                                     java.lang.String docName)
                              throws CaseServiceException

Download a document

Parameters:

context - an IBPMContext value

caseIdentifier - a CaseIdentifier value

docName - a String value

Returns:

an InputStream value

Throws:

CaseServiceException - if an error occurs

downloadDocumentById

java.io.InputStream downloadDocumentById(IBPMContext context,
                                         CaseIdentifier caseIdentifier,
                                         java.lang.String docId)
                                  throws CaseServiceException

Download a document

Parameters:

context - an IBPMContext value

caseIdentifier - a CaseIdentifier value

docId - a String value

Returns:

an InputStream value

Throws:

CaseServiceException - if an error occurs

uploadDocument

boolean uploadDocument(IBPMContext context,
                       CaseIdentifier caseIdentifier,
                       java.lang.String docName,
                       java.lang.String mimeType,
                       java.io.InputStream inputStream,
                       java.lang.String comments,
                       java.lang.String permissionTag)
                throws CaseServiceException

Upload a document

Parameters:

context - an IBPMContext value

caseIdentifier - a CaseIdentifier value

docName - a String

mimeType - a String value

inputStream - an InputStream value

comments - a String value

permissionTag - a String value

createFolders - a boolean value to indicate if folders may be created if needed

Throws:

CaseServiceException - if an error occurs