com.edorasware.cloud.core.provider.caze

Class CmmnCaseProvider

java.lang.Object

com.edorasware.commons.core.provider.entity.BaseEntityProvider<P,L,M>

com.edorasware.commons.core.provider.entity.BaseDomainObjectProvider<T,D,P,E,L,M>

com.edorasware.commons.core.provider.entity.BaseWorkObjectProvider<T,D,P,E,L,M>

com.edorasware.cloud.core.provider.AbstractUserDashboardProvider<com.edorasware.gear.core.caze.CaseId,com.edorasware.gear.core.caze.CaseDefinitionId,com.edorasware.gear.core.caze.CaseProviderId,com.edorasware.gear.core.caze.Case,com.edorasware.gear.core.caze.CaseDefinition,com.edorasware.gear.core.caze.support.CaseProviderListener,com.edorasware.gear.core.caze.Case.Builder,com.edorasware.commons.core.service.entity.WorkObjectDefinitionService<com.edorasware.gear.core.caze.CaseDefinitionId,com.edorasware.gear.core.caze.CaseProviderId,com.edorasware.gear.core.caze.CaseDefinition,?>,com.edorasware.gear.core.caze.CaseManager>

com.edorasware.cloud.core.provider.caze.CmmnCaseProvider

All Implemented Interfaces:

com.edorasware.commons.core.id.Identifiable<com.edorasware.gear.core.caze.CaseProviderId>, com.edorasware.commons.core.provider.entity.DomainObjectProvider<com.edorasware.gear.core.caze.CaseId,com.edorasware.gear.core.caze.CaseDefinitionId,com.edorasware.gear.core.caze.CaseProviderId,com.edorasware.gear.core.caze.CaseDefinition,com.edorasware.gear.core.caze.support.CaseProviderListener>, com.edorasware.commons.core.provider.entity.EntityProvider<com.edorasware.gear.core.caze.CaseProviderId,com.edorasware.gear.core.caze.support.CaseProviderListener>, com.edorasware.commons.core.provider.entity.WorkObjectProvider<com.edorasware.gear.core.caze.CaseId,com.edorasware.gear.core.caze.CaseDefinitionId,com.edorasware.gear.core.caze.CaseProviderId,com.edorasware.gear.core.caze.CaseDefinition,com.edorasware.gear.core.caze.support.CaseProviderListener>, com.edorasware.gear.core.caze.support.CaseProvider

public class CmmnCaseProvider
extends AbstractUserDashboardProvider<com.edorasware.gear.core.caze.CaseId,com.edorasware.gear.core.caze.CaseDefinitionId,com.edorasware.gear.core.caze.CaseProviderId,com.edorasware.gear.core.caze.Case,com.edorasware.gear.core.caze.CaseDefinition,com.edorasware.gear.core.caze.support.CaseProviderListener,com.edorasware.gear.core.caze.Case.Builder,com.edorasware.commons.core.service.entity.WorkObjectDefinitionService<com.edorasware.gear.core.caze.CaseDefinitionId,com.edorasware.gear.core.caze.CaseProviderId,com.edorasware.gear.core.caze.CaseDefinition,?>,com.edorasware.gear.core.caze.CaseManager>
implements com.edorasware.gear.core.caze.support.CaseProvider

Provider implementation for CMMN Case Work Objects.

See https://confluence.edorasware.com/display/EDWDEV/Case+Creation+Sequence

Field Summary

Fields

Modifier and Type	Field and Description
protected com.edorasware.gear.core.caze.CaseDefinitionService	caseDefinitionService Not really needed.
protected com.edorasware.commons.core.identity.CurrentUserService	currentUserService
static com.edorasware.gear.core.caze.CaseProviderId	ID
protected com.edorasware.commons.core.persistence.PrimaryKeyGenerator	keyGenerator Used to create the case Id for new cases.
protected com.edorasware.commons.core.init.LifeCycle	lifeCycle Used to prevent update calls while in system initialization phase (e.g. during DB upgrades).
protected OneEngineListeners	oneEngineListeners The main set of call-backs for edoras one CMMN integration.
protected OnePersistenceListeners	onePersistenceListeners Call-backs providing persistence implementations.
protected com.edorasware.cmmn.engine.core.StateModelManager	stateModelManager Used to create new state models (new CMMN cases).
protected com.edorasware.cmmn.engine.core.SynchronizedLowLevelCmmnService	synchronizedLowLevelCmmnService A service implementation which provides synchronization by serializing access to state models on the level of the case instance.
protected UserManager	userManager Used to get the current locale.
protected com.edorasware.commons.core.service.entity.WorkObjectService	workObjectService Used for case work object lookup.

Fields inherited from class com.edorasware.cloud.core.provider.AbstractUserDashboardProvider

applicationContext

Constructor Summary

Constructors

Constructor and Description

CmmnCaseProvider(com.edorasware.cmmn.engine.core.StateModelManager stateModelManager, com.edorasware.cmmn.engine.core.SynchronizedLowLevelCmmnService synchronizedLowLevelCmmnService, OneEngineListeners oneEngineListeners, OnePersistenceListeners onePersistenceListeners, com.edorasware.commons.core.persistence.PrimaryKeyGenerator keyGenerator, com.edorasware.commons.core.service.entity.WorkObjectService workObjectService, com.edorasware.commons.core.identity.CurrentUserService currentUserService, com.edorasware.commons.core.time.TimeProvider timeProvider, UserManager userManager) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
com.edorasware.gear.core.caze.CaseId	create(com.edorasware.gear.core.caze.CaseDefinitionId definitionId, Map<String,Object> variables, com.edorasware.commons.core.entity.WorkObjectId parentWorkObjectId) Case creation.
com.edorasware.gear.core.caze.Case.Builder	createCaseBuilder(com.edorasware.commons.core.entity.WorkObject<?,?,?> template, com.edorasware.gear.core.caze.CaseDefinitionId definitionId, com.edorasware.commons.core.entity.WorkObjectId parentId) Set up a CMMN case builder given a work object as template.
protected com.edorasware.commons.core.field.FieldChange	findFieldChange(List<com.edorasware.commons.core.field.FieldChange> changes, String variableName)
protected com.edorasware.commons.core.service.entity.WorkObjectDefinitionService<com.edorasware.gear.core.caze.CaseDefinitionId,com.edorasware.gear.core.caze.CaseProviderId,com.edorasware.gear.core.caze.CaseDefinition,?>	getGenericWorkObjectDefinitionService()
protected Object	getValue(Object fieldChangeList, String variableName)
protected boolean	handleCaseVariableUpdate(String caseId, List<com.edorasware.commons.core.field.FieldChange> changes, String caseVariableName, String caseFileItemId, com.edorasware.cmmn.model.TransitionData transitionData)
protected boolean	handleCaseVariableUpdate(String caseId, List<com.edorasware.commons.core.field.FieldChange> changes, com.edorasware.cmmn.model.TransitionData transitionData)
protected boolean	hasBeenChanged(Object fieldChangeList, String variableName)
protected boolean	isPureCommentUpdate(List<com.edorasware.commons.core.field.FieldChange> changes)
void	notifyCreationEvent(com.edorasware.gear.core.caze.Case caze)
void	update(com.edorasware.gear.core.caze.CaseId externalId, List<com.edorasware.commons.core.field.FieldChange> changes)
protected void	update(List<com.edorasware.commons.core.field.FieldChange> changes, com.edorasware.commons.core.any.AnyWorkObject caze, com.edorasware.cmmn.model.TransitionData transitionData)

Methods inherited from class com.edorasware.cloud.core.provider.AbstractUserDashboardProvider

adjustWithAssigneeAndOwner, adjustWithCandidates, create, delete

Methods inherited from class com.edorasware.commons.core.provider.entity.BaseDomainObjectProvider

deployDefinitions, getDefinitions, requiresInitialSynchronization

Methods inherited from class com.edorasware.commons.core.provider.entity.BaseEntityProvider

addListener, execute, getId, getTimeProvider, removeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.edorasware.commons.core.provider.entity.DomainObjectProvider

create, delete, deployDefinitions, getDefinitions, requiresInitialSynchronization

Methods inherited from interface com.edorasware.commons.core.provider.entity.EntityProvider

addListener, removeListener

Methods inherited from interface com.edorasware.commons.core.id.Identifiable

getId

Field Detail

ID

public static final com.edorasware.gear.core.caze.CaseProviderId ID

stateModelManager

protected final com.edorasware.cmmn.engine.core.StateModelManager stateModelManager

Used to create new state models (new CMMN cases).

synchronizedLowLevelCmmnService

protected final com.edorasware.cmmn.engine.core.SynchronizedLowLevelCmmnService synchronizedLowLevelCmmnService

A service implementation which provides synchronization by serializing access to state models on the level of the case instance.

oneEngineListeners

protected final OneEngineListeners oneEngineListeners

The main set of call-backs for edoras one CMMN integration.

onePersistenceListeners

protected final OnePersistenceListeners onePersistenceListeners

Call-backs providing persistence implementations.

keyGenerator

protected final com.edorasware.commons.core.persistence.PrimaryKeyGenerator keyGenerator

Used to create the case Id for new cases.

userManager

protected final UserManager userManager

Used to get the current locale.

workObjectService

protected final com.edorasware.commons.core.service.entity.WorkObjectService workObjectService

Used for case work object lookup.

currentUserService

protected final com.edorasware.commons.core.identity.CurrentUserService currentUserService

caseDefinitionService

protected com.edorasware.gear.core.caze.CaseDefinitionService caseDefinitionService

Not really needed. Provided here to be able to correctly implement a base class method.

lifeCycle

@Autowired
protected com.edorasware.commons.core.init.LifeCycle lifeCycle

Used to prevent update calls while in system initialization phase (e.g. during DB upgrades).

Constructor Detail

CmmnCaseProvider

public CmmnCaseProvider(com.edorasware.cmmn.engine.core.StateModelManager stateModelManager,
                com.edorasware.cmmn.engine.core.SynchronizedLowLevelCmmnService synchronizedLowLevelCmmnService,
                OneEngineListeners oneEngineListeners,
                OnePersistenceListeners onePersistenceListeners,
                com.edorasware.commons.core.persistence.PrimaryKeyGenerator keyGenerator,
                com.edorasware.commons.core.service.entity.WorkObjectService workObjectService,
                com.edorasware.commons.core.identity.CurrentUserService currentUserService,
                com.edorasware.commons.core.time.TimeProvider timeProvider,
                UserManager userManager)

Constructor. Passes timeProvider, CaseManager and provider Id to superclass. Assigns method parameters to members.

Parameters:

stateModelManager - StateModelManager

synchronizedLowLevelCmmnService - the cmmn service to use. Must be synchronized

oneEngineListeners - engine listeners

onePersistenceListeners - persistence listeners

keyGenerator - key generator

workObjectService - work object service

currentUserService - current user service

timeProvider - time provider

userManager - user manager

Method Detail

create

public com.edorasware.gear.core.caze.CaseId create(com.edorasware.gear.core.caze.CaseDefinitionId definitionId,
                                          Map<String,Object> variables,
                                          com.edorasware.commons.core.entity.WorkObjectId parentWorkObjectId)

Case creation. Instantiate a state machine for the case.

Specified by:

create in interface com.edorasware.commons.core.provider.entity.WorkObjectProvider<com.edorasware.gear.core.caze.CaseId,com.edorasware.gear.core.caze.CaseDefinitionId,com.edorasware.gear.core.caze.CaseProviderId,com.edorasware.gear.core.caze.CaseDefinition,com.edorasware.gear.core.caze.support.CaseProviderListener>

Overrides:

create in class AbstractUserDashboardProvider<com.edorasware.gear.core.caze.CaseId,com.edorasware.gear.core.caze.CaseDefinitionId,com.edorasware.gear.core.caze.CaseProviderId,com.edorasware.gear.core.caze.Case,com.edorasware.gear.core.caze.CaseDefinition,com.edorasware.gear.core.caze.support.CaseProviderListener,com.edorasware.gear.core.caze.Case.Builder,com.edorasware.commons.core.service.entity.WorkObjectDefinitionService<com.edorasware.gear.core.caze.CaseDefinitionId,com.edorasware.gear.core.caze.CaseProviderId,com.edorasware.gear.core.caze.CaseDefinition,?>,com.edorasware.gear.core.caze.CaseManager>

Throws:

RuntimeException - if the case could not be created due to an CMN XML parsing problem or due to a general IO-exception.

notifyCreationEvent

public void notifyCreationEvent(com.edorasware.gear.core.caze.Case caze)

Specified by:

notifyCreationEvent in class AbstractUserDashboardProvider<com.edorasware.gear.core.caze.CaseId,com.edorasware.gear.core.caze.CaseDefinitionId,com.edorasware.gear.core.caze.CaseProviderId,com.edorasware.gear.core.caze.Case,com.edorasware.gear.core.caze.CaseDefinition,com.edorasware.gear.core.caze.support.CaseProviderListener,com.edorasware.gear.core.caze.Case.Builder,com.edorasware.commons.core.service.entity.WorkObjectDefinitionService<com.edorasware.gear.core.caze.CaseDefinitionId,com.edorasware.gear.core.caze.CaseProviderId,com.edorasware.gear.core.caze.CaseDefinition,?>,com.edorasware.gear.core.caze.CaseManager>

update

public void update(com.edorasware.gear.core.caze.CaseId externalId,
          List<com.edorasware.commons.core.field.FieldChange> changes)

Specified by:

update in interface com.edorasware.commons.core.provider.entity.DomainObjectProvider<com.edorasware.gear.core.caze.CaseId,com.edorasware.gear.core.caze.CaseDefinitionId,com.edorasware.gear.core.caze.CaseProviderId,com.edorasware.gear.core.caze.CaseDefinition,com.edorasware.gear.core.caze.support.CaseProviderListener>

Overrides:

update in class AbstractUserDashboardProvider<com.edorasware.gear.core.caze.CaseId,com.edorasware.gear.core.caze.CaseDefinitionId,com.edorasware.gear.core.caze.CaseProviderId,com.edorasware.gear.core.caze.Case,com.edorasware.gear.core.caze.CaseDefinition,com.edorasware.gear.core.caze.support.CaseProviderListener,com.edorasware.gear.core.caze.Case.Builder,com.edorasware.commons.core.service.entity.WorkObjectDefinitionService<com.edorasware.gear.core.caze.CaseDefinitionId,com.edorasware.gear.core.caze.CaseProviderId,com.edorasware.gear.core.caze.CaseDefinition,?>,com.edorasware.gear.core.caze.CaseManager>

update

protected void update(List<com.edorasware.commons.core.field.FieldChange> changes,
          com.edorasware.commons.core.any.AnyWorkObject caze,
          com.edorasware.cmmn.model.TransitionData transitionData)

handleCaseVariableUpdate

protected boolean handleCaseVariableUpdate(String caseId,
                               List<com.edorasware.commons.core.field.FieldChange> changes,
                               com.edorasware.cmmn.model.TransitionData transitionData)
                                    throws JAXBException,
                                           IOException

Throws:

JAXBException

IOException

handleCaseVariableUpdate

protected boolean handleCaseVariableUpdate(String caseId,
                               List<com.edorasware.commons.core.field.FieldChange> changes,
                               String caseVariableName,
                               String caseFileItemId,
                               com.edorasware.cmmn.model.TransitionData transitionData)
                                    throws IOException,
                                           JAXBException

Throws:

IOException

JAXBException

hasBeenChanged

protected boolean hasBeenChanged(Object fieldChangeList,
                     String variableName)

getValue

protected Object getValue(Object fieldChangeList,
              String variableName)

findFieldChange

protected com.edorasware.commons.core.field.FieldChange findFieldChange(List<com.edorasware.commons.core.field.FieldChange> changes,
                                                            String variableName)

isPureCommentUpdate

protected boolean isPureCommentUpdate(List<com.edorasware.commons.core.field.FieldChange> changes)

createCaseBuilder

public com.edorasware.gear.core.caze.Case.Builder createCaseBuilder(com.edorasware.commons.core.entity.WorkObject<?,?,?> template,
                                                           com.edorasware.gear.core.caze.CaseDefinitionId definitionId,
                                                           com.edorasware.commons.core.entity.WorkObjectId parentId)

Set up a CMMN case builder given a work object as template.

getGenericWorkObjectDefinitionService

protected com.edorasware.commons.core.service.entity.WorkObjectDefinitionService<com.edorasware.gear.core.caze.CaseDefinitionId,com.edorasware.gear.core.caze.CaseProviderId,com.edorasware.gear.core.caze.CaseDefinition,?> getGenericWorkObjectDefinitionService()

Specified by:

getGenericWorkObjectDefinitionService in class AbstractUserDashboardProvider<com.edorasware.gear.core.caze.CaseId,com.edorasware.gear.core.caze.CaseDefinitionId,com.edorasware.gear.core.caze.CaseProviderId,com.edorasware.gear.core.caze.Case,com.edorasware.gear.core.caze.CaseDefinition,com.edorasware.gear.core.caze.support.CaseProviderListener,com.edorasware.gear.core.caze.Case.Builder,com.edorasware.commons.core.service.entity.WorkObjectDefinitionService<com.edorasware.gear.core.caze.CaseDefinitionId,com.edorasware.gear.core.caze.CaseProviderId,com.edorasware.gear.core.caze.CaseDefinition,?>,com.edorasware.gear.core.caze.CaseManager>