com.edorasware.one.caze.internal

Class DefaultCaseArchiveManager

java.lang.Object

com.edorasware.one.caze.internal.DefaultCaseArchiveManager

All Implemented Interfaces:

CaseArchiveManager

public class DefaultCaseArchiveManager
extends Object
implements CaseArchiveManager

This class provides default implementation of case archive manager

Constructor Summary

Constructors

Constructor and Description
DefaultCaseArchiveManager(AnyWorkObjectService anyWorkObjectService, NotificationService notificationService, WorkObjectService workObjectService)

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 caseId, String actionComment) Tests if the case identified by the id parameter is a CMMN case.
void	archiveSingleCase(Optional<String> processToOmit, String caseId, String actionComment) Archives the case.
void	archiveSingleWorkObject(String id, String actionComment) Archives the work object

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultCaseArchiveManager

public DefaultCaseArchiveManager(AnyWorkObjectService anyWorkObjectService,
                                 NotificationService notificationService,
                                 WorkObjectService workObjectService)

Method Detail

archive

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

Description copied from interface: CaseArchiveManager

Archives given case

Specified by:

archive in interface CaseArchiveManager

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

public void archiveSingleCase(Optional<String> processToOmit,
                              String caseId,
                              String actionComment)

Description copied from interface: CaseArchiveManager

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

Specified by:

archiveSingleCase in interface CaseArchiveManager

Parameters:

processToOmit - process to omit id

caseId - case to archive

actionComment - comment to add to the action

archiveCmmnCase

public boolean archiveCmmnCase(String caseId,
                               String actionComment)

Description copied from interface: CaseArchiveManager

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.

Specified by:

archiveCmmnCase in interface CaseArchiveManager

Parameters:

caseId - 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

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

Description copied from interface: CaseArchiveManager

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

Specified by:

archiveCaseAndDocuments in interface CaseArchiveManager

Parameters:

processToOmit - process to omit id

caseId - case to archive

actionComment - comment to add to the action

archiveSingleWorkObject

public void archiveSingleWorkObject(String id,
                                    String actionComment)

Description copied from interface: CaseArchiveManager

Archives the work object

Specified by:

archiveSingleWorkObject in interface CaseArchiveManager

Parameters:

id - work object to archive

actionComment - comment to add to the action