com.edorasware.cmmn.model.casefile

Class CaseFile

java.lang.Object

com.edorasware.cmmn.model.casefile.CaseFile

public class CaseFile
extends Object

This class represents a case’s case file. It contains one or more case file items.

Constructor Summary

Constructors

Constructor and Description
CaseFile(StateModel stateModel, String caseClientId, List<TCaseFileItemDefinition> tCaseFileItemDefinitions, TCaseFile tCaseFile) Construct the case file.

Method Summary

Modifier and Type	Method and Description
void	applyVisitor(CaseFileItemInstanceVisitor visitor) Apply a visitor to this case file (GOF visitor pattern).
ArrayList<CaseFileItemAction>	createCaseFileItemActions(TransitionData transitionData, EvaluationListeners evaluationListeners) Create the case file item actions.
String	getCaseClientId()
CaseFileItem	getCaseFileItemById(String caseFileItemId)
Map<String,CaseFileItemInstance>	getCaseFileItemInstancesByClientId()
HashMap<String,CaseFileItemInstance>	getCaseFileItemInstancesByInstanceId()
ArrayList<CaseFileItem>	getCaseFileItems(String definitionType) Get the case file item for the given definition type, or all if the type passed is null.
StateModel	getStateModel()
CaseFileItemInstance	handleCaseFileItemTransition(String sourceCaseFileItemId, CaseFileItemTransition caseFileItemTransition, TransitionData transitionData, EngineListeners engineListeners, PersistenceListeners persistenceListeners)
ArrayList<String>	initCaseFileItemInstances(TransitionData transitionData, EngineListeners engineListeners)
void	restoreFromExternalState(CasePlanModelData externalState)

Methods inherited from class java.lang.Object

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

Constructor Detail

CaseFile

public CaseFile(StateModel stateModel,
                String caseClientId,
                List<TCaseFileItemDefinition> tCaseFileItemDefinitions,
                TCaseFile tCaseFile)

Construct the case file. Setup the caseFileItemsById based on the passed list of TCaseFileItemDefinitions.

Parameters:

stateModel - the state model

caseClientId - the client case id

tCaseFileItemDefinitions - the case file item definitions

tCaseFile - the case file

Method Detail

initCaseFileItemInstances

public ArrayList<String> initCaseFileItemInstances(TransitionData transitionData,
                                                   EngineListeners engineListeners)

createCaseFileItemActions

public ArrayList<CaseFileItemAction> createCaseFileItemActions(TransitionData transitionData,
                                                               EvaluationListeners evaluationListeners)

Create the case file item actions. These are create actions for the case file items for which new instances can be created.

Parameters:

transitionData - optional evaluation context.

evaluationListeners - the call-backs used to evaluate run-time action name expressions.

Returns:

the current list of create actions.

getCaseFileItems

public ArrayList<CaseFileItem> getCaseFileItems(String definitionType)

Get the case file item for the given definition type, or all if the type passed is null.

Parameters:

definitionType - the type of case file item to return.

Returns:

a list of the case file items of the given type. The list may be empty but never null. By passing null as definitionType, all case file items will be returned.

restoreFromExternalState

public void restoreFromExternalState(CasePlanModelData externalState)

handleCaseFileItemTransition

public CaseFileItemInstance handleCaseFileItemTransition(String sourceCaseFileItemId,
                                                         CaseFileItemTransition caseFileItemTransition,
                                                         TransitionData transitionData,
                                                         EngineListeners engineListeners,
                                                         PersistenceListeners persistenceListeners)

Parameters:

sourceCaseFileItemId - for CREATE, this is the model ID of the case file item (id property). Once the case file item instance exists, the clientId or alternatively the instanceId of the case file item instance is expected in this parameter. Note: when passing an instanceId, the instance suffix (i.e. "~1") is optional. Skipping the instance suffix will always refer to the latest instance.

caseFileItemTransition - the transition to apply.

engineListeners - the client listeners handling any client-side action resulting from this call.

transitionData - the transitionData.

Returns:

the case file item instance

getCaseFileItemInstancesByClientId

public Map<String,CaseFileItemInstance> getCaseFileItemInstancesByClientId()

getCaseFileItemInstancesByInstanceId

public HashMap<String,CaseFileItemInstance> getCaseFileItemInstancesByInstanceId()

getCaseClientId

public String getCaseClientId()

Returns:

the case client ID.

getCaseFileItemById

public CaseFileItem getCaseFileItemById(String caseFileItemId)

getStateModel

public StateModel getStateModel()

applyVisitor

public void applyVisitor(CaseFileItemInstanceVisitor visitor)

Apply a visitor to this case file (GOF visitor pattern).

Parameters:

visitor - the case file item visitor