oracle.bpm.casemgmt
Interface ICaseDocumentService

All Known Subinterfaces:

ICaseService

public interface ICaseDocumentService

This interface lists the APIs related to case documents

Method Summary

boolean	deleteDocument(IBPMContext context, CaseIdentifier caseIdentifier, CaseDocumentObject caseDocObj, boolean allVersions) Delete a case document
java.util.List<CaseDocumentObject>	listDocuments(IBPMContext context, CaseIdentifier caseIdentifier) List the documents attached to a case

Method Detail

listDocuments

java.util.List<CaseDocumentObject> listDocuments(IBPMContext context,
                                                 CaseIdentifier caseIdentifier)
                                                 throws CaseServiceException

List the documents attached to a case

Parameters:

context - an IBPMContext value

caseIdentifier - a CaseIdentifier value

Returns:

a List value

Throws:

CaseServiceException - if an error occurs

deleteDocument

boolean deleteDocument(IBPMContext context,
                       CaseIdentifier caseIdentifier,
                       CaseDocumentObject caseDocObj,
                       boolean allVersions)
                       throws CaseServiceException

Delete a case document

Parameters:

context - an IBPMContext value

caseIdentifier - a CaseIdentifier value

caseDocObj - a CaseDocumentObject value

allVersions - a boolean value. If true all versions of the document will be deleted

Returns:

a boolean value. If true, delete was successfull

Throws:

CaseServiceException - if an error occurs