Package com.aquima.interactions.process.impl

Class ProcessCase

java.lang.Object

com.aquima.interactions.process.impl.ProcessCase

All Implemented Interfaces:

IProcessCase

public final class ProcessCase
extends Object
implements IProcessCase

Class exposing process engine functionality for a case.

Since:

7.1

Author:

Jon van Leuven

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ProcessCase(ProcessEngine processEngine, IMetaModel caseMetaModel, ICaseModel model)

Method Summary

Modifier and Type	Method	Description
protected void	addInstance(ICaseDataInstance instanceModel)
void	clearInternalCaseDataCache()
IProcessTask	createTask(IUserData userData, String taskName, DateTimeValue startDate, String[] roles)	This method may be used to create a new task for this case.
IProcessTask[]	getAvailableTasks(IUserData userData)	This method will returns an array containing all the process tasks that may be executed for the current case.
IProfile	getCaseProfile()	This method returns a read-only object containing the case profile.
IProfile	getCaseProfile(CaseDataChangeListener caseDataChangeListener)	This method returns a read-only object containing the case profile.
DateTimeValue	getCreationDate()	This method returns the creation date of the case.
IMultilingualText	getDisplayName()
long	getId()	This method returns the unique ID of the process case.
protected ICaseDataInstance	getInstanceModel(long instanceId)
protected IProfile	getInternalCaseProfile(CaseDataChangeListener processCaseDataListener)
String	getName()	This method returns the name of the of the case.
CaseStatusType	getStatus()	This method returns the status of the case, never null
boolean	isLocked()	This method returns a boolean indicating if the case is locked.
void	mapCaseProfile(IMapping mapping, IProfile sourceMappingProfile)	This method maps a source profile to the case profile using the specified mapping.
protected void	removeInstance(ICaseDataInstance instanceModel)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessCase

protected ProcessCase(ProcessEngine processEngine,
                      IMetaModel caseMetaModel,
                      ICaseModel model)

Method Detail

createTask

public IProcessTask createTask(IUserData userData,
                               String taskName,
                               DateTimeValue startDate,
                               String[] roles)

Description copied from interface: IProcessCase

This method may be used to create a new task for this case. The newly created task will not be part of any existing process, but defined as a loose task similar to an ad-hoc task.

Specified by:

createTask in interface IProcessCase

Parameters:

userData - Object containing information about the current user.

taskName - The name or the description of the task.

startDate - The time at which the task should become active.

roles - The roles that are required to execute the task.

Returns:

Object representing the newly created task.

getAvailableTasks

public IProcessTask[] getAvailableTasks(IUserData userData)

Description copied from interface: IProcessCase

This method will returns an array containing all the process tasks that may be executed for the current case. If the current case is locked, or no process steps are available, the method will return an empty array. The returned process steps are bound to the user they are requested for.

Specified by:

getAvailableTasks in interface IProcessCase

Parameters:

userData - Object containing information about the current user.

Returns:

Array containing the process steps that may be executed by the supplied user.

getId

public long getId()

Description copied from interface: IProcessCase

This method returns the unique ID of the process case. The ID of the case is generated at the moment the case is created.

Specified by:

getId in interface IProcessCase

Returns:

The unique ID of the case.

getName

public String getName()

Description copied from interface: IProcessCase

This method returns the name of the of the case. As the name is optional, this method may return a null value.

Specified by:

getName in interface IProcessCase

Returns:

The name of the case.

getCreationDate

public DateTimeValue getCreationDate()

Description copied from interface: IProcessCase

This method returns the creation date of the case.

Specified by:

getCreationDate in interface IProcessCase

Returns:

The creation date of the case, never null

getStatus

public CaseStatusType getStatus()

Description copied from interface: IProcessCase

This method returns the status of the case, never null

Specified by:

getStatus in interface IProcessCase

Returns:

The status of the case

isLocked

public boolean isLocked()

Description copied from interface: IProcessCase

This method returns a boolean indicating if the case is locked. A case will be locked as soon as a task is started for the case, and the lock will be released again when the task has been completed or aborted. Cases that are locked will not return any available process steps.

Specified by:

isLocked in interface IProcessCase

Returns:

Boolean indicating if the case is locked.

getCaseProfile

public IProfile getCaseProfile()
                        throws UnknownAttributeException,
                               UnknownEntityException

Description copied from interface: IProcessCase

This method returns a read-only object containing the case profile. The case profile is updated after each process step that has been executed.

Specified by:

getCaseProfile in interface IProcessCase

Returns:

Object containing the case profile.

Throws:

UnknownAttributeException - Is thrown when the case profile contains data for an unknown attribute.

UnknownEntityException - Is thrown when the case profile contains data for an unknown entity.

getCaseProfile

public IProfile getCaseProfile(CaseDataChangeListener caseDataChangeListener)
                        throws UnknownAttributeException,
                               UnknownEntityException

Description copied from interface: IProcessCase

This method returns a read-only object containing the case profile. The case profile is updated after each process step that has been executed.

Specified by:

getCaseProfile in interface IProcessCase

Parameters:

caseDataChangeListener - profile changeListener for retrieving case-data set to the caseProfile

Returns:

Object containing the case profile.

Throws:

UnknownAttributeException - Is thrown when the case profile contains data for an unknown attribute.

UnknownEntityException - Is thrown when the case profile contains data for an unknown entity.

mapCaseProfile

public void mapCaseProfile(IMapping mapping,
                           IProfile sourceMappingProfile)
                    throws UnknownAttributeException,
                           UnknownEntityException

Description copied from interface: IProcessCase

This method maps a source profile to the case profile using the specified mapping.

Specified by:

mapCaseProfile in interface IProcessCase

Parameters:

mapping - A mapping to be applied after the profile has been recreated

sourceMappingProfile - The profile to be used as source for the mapping update

Throws:

UnknownAttributeException - Is thrown when the case profile contains data for an unknown attribute.

UnknownEntityException - Is thrown when the case profile contains data for an unknown entity.

getInstanceModel

protected ICaseDataInstance getInstanceModel(long instanceId)

addInstance

protected void addInstance(ICaseDataInstance instanceModel)

removeInstance

protected void removeInstance(ICaseDataInstance instanceModel)

getInternalCaseProfile

protected IProfile getInternalCaseProfile(CaseDataChangeListener processCaseDataListener)
                                   throws UnknownAttributeException,
                                          UnknownEntityException

Throws:

UnknownAttributeException

UnknownEntityException

clearInternalCaseDataCache

public void clearInternalCaseDataCache()

getDisplayName

public IMultilingualText getDisplayName()

Specified by:

getDisplayName in interface IProcessCase

Returns:

the display name or null if there is none