com.edorasware.one.caze

Interface CaseArchiveManager

All Known Implementing Classes:

DefaultCaseArchiveManager

public interface CaseArchiveManager

Provides methods to archive case and documents

Method Summary

Modifier and Type	Method and Description
void	archive(Optional<String> processToOmit, AnyWorkObjectService anyWorkObjectService, String caseId, String actionComment) Archives given case
void	archiveCaseAndDocuments(Optional<String> processToOmit, String caseId, String actionComment) Archives case and all it active documents.
boolean	archiveCmmnCase(String id, String actionComment) Tests if the case identified by the id parameter is a CMMN case.
void	archiveSingleCase(Optional<String> processToOmit, String id, String actionComment) Archives the case.
void	archiveSingleWorkObject(String id, String actionComment) Archives the work object

Method Detail

archive

void archive(Optional<String> processToOmit,
             AnyWorkObjectService anyWorkObjectService,
             String caseId,
             String actionComment)

Archives given case

Parameters:

processToOmit - process to omit id

anyWorkObjectService - process service which is responsible for process archivation

caseId - case to archive

actionComment - comment to add to the action

archiveSingleCase

void archiveSingleCase(Optional<String> processToOmit,
                       String id,
                       String actionComment)

Archives the case. The case can not contain any active item

Parameters:

processToOmit - process to omit id

id - case to archive

actionComment - comment to add to the action

Throws:

OneException - in the case when case has active sub items

archiveCmmnCase

boolean archiveCmmnCase(String id,
                        String actionComment)

Tests if the case identified by the id parameter is a CMMN case. If so it archives the case which leads (by means of notification of the CmmnCaseProvider) to the termination of the case. Termination of the case also means that the case engine terminates any pending tasks like human tasks, process tasks and case tasks.

Parameters:

id - the case ID.

actionComment - the action comment to pass on.

Returns:

true if the case identified by the id parameter is indeed a CMMN case (and it was thus archived). Returns false otherwise.

archiveCaseAndDocuments

void archiveCaseAndDocuments(Optional<String> processToOmit,
                             String caseId,
                             String actionComment)

Archives case and all it active documents. In the case of any other active work objects exception is thrown

Parameters:

processToOmit - process to omit id

caseId - case to archive

actionComment - comment to add to the action

Throws:

{@linkOneException} - in the case when case has active non Document sub items

archiveSingleWorkObject

void archiveSingleWorkObject(String id,
                             String actionComment)

Archives the work object

Parameters:

id - work object to archive

actionComment - comment to add to the action