org.flowable.cmmn.engine.impl

Class CmmnHistoryServiceImpl

java.lang.Object

org.flowable.common.engine.impl.service.CommonServiceImpl<C>

org.flowable.common.engine.impl.service.CommonEngineServiceImpl<CmmnEngineConfiguration>

org.flowable.cmmn.engine.impl.CmmnHistoryServiceImpl

All Implemented Interfaces:

CmmnHistoryService

public class CmmnHistoryServiceImpl
extends CommonEngineServiceImpl<CmmnEngineConfiguration>
implements CmmnHistoryService

Author:

Joram Barrez

Field Summary

Fields inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

commandExecutor

Fields inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

configuration

Constructor Summary

Constructors

Constructor and Description
CmmnHistoryServiceImpl(CmmnEngineConfiguration engineConfiguration)

Method Summary

Modifier and Type	Method and Description
CaseReactivationBuilder	createCaseReactivationBuilder(String caseInstanceId) Creates a new case reactivation builder used to reactivate an archived / finished case with various options.
HistoricCaseInstanceQuery	createHistoricCaseInstanceQuery()
HistoricMilestoneInstanceQuery	createHistoricMilestoneInstanceQuery()
HistoricPlanItemInstanceQuery	createHistoricPlanItemInstanceQuery()
HistoricTaskInstanceQuery	createHistoricTaskInstanceQuery()
HistoricTaskLogEntryBuilder	createHistoricTaskLogEntryBuilder() Create new task log entry builder to the log task event without predefined values from the task
HistoricTaskLogEntryBuilder	createHistoricTaskLogEntryBuilder(TaskInfo task) Create new task log entry builder to the log task event
HistoricTaskLogEntryQuery	createHistoricTaskLogEntryQuery() Returns a new HistoricTaskLogEntryQuery that can be used to dynamically query task log entries.
HistoricVariableInstanceQuery	createHistoricVariableInstanceQuery()
NativeHistoricTaskLogEntryQuery	createNativeHistoricTaskLogEntryQuery() Returns a new NativeHistoricTaskLogEntryQuery for HistoricTaskLogEntrys.
void	deleteHistoricCaseInstance(String caseInstanceId)
void	deleteHistoricTaskInstance(String taskId) Deletes historic task instance.
void	deleteHistoricTaskLogEntry(long logNumber) Deletes user task log entry by its log number
List<HistoricEntityLink>	getHistoricEntityLinkChildrenForCaseInstance(String caseInstanceId) Retrieves the HistoricEntityLinks associated with the given case instance.
List<HistoricEntityLink>	getHistoricEntityLinkChildrenWithSameRootAsCaseInstance(String caseInstanceId) Retrieves all the HistoricEntityLinks associated with same root as the given case instance.
List<HistoricEntityLink>	getHistoricEntityLinkParentsForCaseInstance(String caseInstanceId) Retrieves the HistoricEntityLinks where the given case instance is referenced.
List<HistoricIdentityLink>	getHistoricIdentityLinksForCaseInstance(String caseInstanceId) Retrieves the HistoricIdentityLinks associated with the given case instance.
List<HistoricIdentityLink>	getHistoricIdentityLinksForPlanItemInstance(String planItemInstanceId) Retrieves the HistoricIdentityLinks associated with the given plan item instance.
List<HistoricIdentityLink>	getHistoricIdentityLinksForTask(String taskId) Retrieves the HistoricIdentityLinks associated with the given task.
List<StageResponse>	getStageOverview(String caseInstanceId) Gives back a stage overview of the historic case instance which includes the stage information of the case model.

Methods inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

getCommandExecutor, setCommandExecutor

Methods inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

getConfiguration

Methods inherited from class java.lang.Object

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

Constructor Detail

CmmnHistoryServiceImpl

public CmmnHistoryServiceImpl(CmmnEngineConfiguration engineConfiguration)

Method Detail

createHistoricCaseInstanceQuery

public HistoricCaseInstanceQuery createHistoricCaseInstanceQuery()

Specified by:

createHistoricCaseInstanceQuery in interface CmmnHistoryService

createHistoricMilestoneInstanceQuery

public HistoricMilestoneInstanceQuery createHistoricMilestoneInstanceQuery()

Specified by:

createHistoricMilestoneInstanceQuery in interface CmmnHistoryService

createHistoricVariableInstanceQuery

public HistoricVariableInstanceQuery createHistoricVariableInstanceQuery()

Specified by:

createHistoricVariableInstanceQuery in interface CmmnHistoryService

createHistoricPlanItemInstanceQuery

public HistoricPlanItemInstanceQuery createHistoricPlanItemInstanceQuery()

Specified by:

createHistoricPlanItemInstanceQuery in interface CmmnHistoryService

getStageOverview

public List<StageResponse> getStageOverview(String caseInstanceId)

Description copied from interface: CmmnHistoryService

Gives back a stage overview of the historic case instance which includes the stage information of the case model.

Specified by:

getStageOverview in interface CmmnHistoryService

Parameters:

caseInstanceId - id of the case instance, cannot be null.

Returns:

list of stage info objects

deleteHistoricCaseInstance

public void deleteHistoricCaseInstance(String caseInstanceId)

Specified by:

deleteHistoricCaseInstance in interface CmmnHistoryService

createHistoricTaskInstanceQuery

public HistoricTaskInstanceQuery createHistoricTaskInstanceQuery()

Specified by:

createHistoricTaskInstanceQuery in interface CmmnHistoryService

deleteHistoricTaskInstance

public void deleteHistoricTaskInstance(String taskId)

Description copied from interface: CmmnHistoryService

Deletes historic task instance. This might be useful for tasks that are dynamically created and then completed. If the historic task instance doesn't exist, no exception is thrown and the method returns normal.

Specified by:

deleteHistoricTaskInstance in interface CmmnHistoryService

createCaseReactivationBuilder

public CaseReactivationBuilder createCaseReactivationBuilder(String caseInstanceId)

Description copied from interface: CmmnHistoryService

Creates a new case reactivation builder used to reactivate an archived / finished case with various options.

Specified by:

createCaseReactivationBuilder in interface CmmnHistoryService

Parameters:

caseInstanceId - the id of the historical case to be reactivated

Returns:

the case reactivation builder

getHistoricIdentityLinksForCaseInstance

public List<HistoricIdentityLink> getHistoricIdentityLinksForCaseInstance(String caseInstanceId)

Description copied from interface: CmmnHistoryService

Retrieves the HistoricIdentityLinks associated with the given case instance. Such an IdentityLink informs how a certain identity (eg. group or user) is associated with a certain case instance, even if the instance is completed as opposed to IdentityLinks which only exist for active instances.

Specified by:

getHistoricIdentityLinksForCaseInstance in interface CmmnHistoryService

getHistoricIdentityLinksForPlanItemInstance

public List<HistoricIdentityLink> getHistoricIdentityLinksForPlanItemInstance(String planItemInstanceId)

Description copied from interface: CmmnHistoryService

Retrieves the HistoricIdentityLinks associated with the given plan item instance. Such an IdentityLink informs how a certain identity (eg. group or user) is associated with a certain case instance, even if the instance is completed as opposed to IdentityLinks which only exist for active instances.

Specified by:

getHistoricIdentityLinksForPlanItemInstance in interface CmmnHistoryService

getHistoricIdentityLinksForTask

public List<HistoricIdentityLink> getHistoricIdentityLinksForTask(String taskId)

Description copied from interface: CmmnHistoryService

Retrieves the HistoricIdentityLinks associated with the given task. Such an IdentityLink informs how a certain identity (eg. group or user) is associated with a certain task (eg. as candidate, assignee, etc.), even if the task is completed as opposed to IdentityLinks which only exist for active tasks.

Specified by:

getHistoricIdentityLinksForTask in interface CmmnHistoryService

getHistoricEntityLinkChildrenForCaseInstance

public List<HistoricEntityLink> getHistoricEntityLinkChildrenForCaseInstance(String caseInstanceId)

Description copied from interface: CmmnHistoryService

Retrieves the HistoricEntityLinks associated with the given case instance.

Specified by:

getHistoricEntityLinkChildrenForCaseInstance in interface CmmnHistoryService

getHistoricEntityLinkChildrenWithSameRootAsCaseInstance

public List<HistoricEntityLink> getHistoricEntityLinkChildrenWithSameRootAsCaseInstance(String caseInstanceId)

Description copied from interface: CmmnHistoryService

Retrieves all the HistoricEntityLinks associated with same root as the given case instance.

Specified by:

getHistoricEntityLinkChildrenWithSameRootAsCaseInstance in interface CmmnHistoryService

getHistoricEntityLinkParentsForCaseInstance

public List<HistoricEntityLink> getHistoricEntityLinkParentsForCaseInstance(String caseInstanceId)

Description copied from interface: CmmnHistoryService

Retrieves the HistoricEntityLinks where the given case instance is referenced.

Specified by:

getHistoricEntityLinkParentsForCaseInstance in interface CmmnHistoryService

deleteHistoricTaskLogEntry

public void deleteHistoricTaskLogEntry(long logNumber)

Description copied from interface: CmmnHistoryService

Deletes user task log entry by its log number

Specified by:

deleteHistoricTaskLogEntry in interface CmmnHistoryService

Parameters:

logNumber - user task log entry identifier

createHistoricTaskLogEntryBuilder

public HistoricTaskLogEntryBuilder createHistoricTaskLogEntryBuilder(TaskInfo task)

Description copied from interface: CmmnHistoryService

Create new task log entry builder to the log task event

Specified by:

createHistoricTaskLogEntryBuilder in interface CmmnHistoryService

Parameters:

task - to which is log related to

createHistoricTaskLogEntryBuilder

public HistoricTaskLogEntryBuilder createHistoricTaskLogEntryBuilder()

Description copied from interface: CmmnHistoryService

Create new task log entry builder to the log task event without predefined values from the task

Specified by:

createHistoricTaskLogEntryBuilder in interface CmmnHistoryService

createHistoricTaskLogEntryQuery

public HistoricTaskLogEntryQuery createHistoricTaskLogEntryQuery()

Description copied from interface: CmmnHistoryService

Returns a new HistoricTaskLogEntryQuery that can be used to dynamically query task log entries.

Specified by:

createHistoricTaskLogEntryQuery in interface CmmnHistoryService

createNativeHistoricTaskLogEntryQuery

public NativeHistoricTaskLogEntryQuery createNativeHistoricTaskLogEntryQuery()

Description copied from interface: CmmnHistoryService

Returns a new NativeHistoricTaskLogEntryQuery for HistoricTaskLogEntrys.

Specified by:

createNativeHistoricTaskLogEntryQuery in interface CmmnHistoryService