Class WorkflowStateDao

java.lang.Object

de.xima.cmn.dao.AbstractDao<WorkflowState, Long, IEntityContext>

de.xima.fc.dao.impl.GenericDao<WorkflowState>

de.xima.fc.dao.impl.WorkflowStateDao

All Implemented Interfaces:

de.xima.cmn.dao.interfaces.IAbstractDao<WorkflowState, Long, IEntityContext>, IGenericDao<WorkflowState>, IWorkflowStateDao

public class WorkflowStateDao
extends GenericDao<WorkflowState>
implements IWorkflowStateDao

The default implementation of IWorkflowStateDao that can be accessed via DaoProvider.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Field Summary

Fields inherited from class de.xima.cmn.dao.AbstractDao

entityClass, LOG

Constructor Summary

Constructors

Constructor	Description
WorkflowStateDao()	Creates a new instance of this DAO.

Method Summary

Modifier and Type	Method	Description
List<WorkflowState>	createDefaultStates()	Deprecated. use createDefaultStates(Locale)
List<WorkflowState>	createDefaultStates(Locale locale)	Creates the system default workflow states
List<WorkflowState>	getAllByWorkflowVersion(IEntityContext ec, Projekt project, long versionNumber)	Finds all states of the given workflow version.
List<WorkflowState>	getAllByWorkflowVersion(IEntityContext ec, WorkflowVersion workflowVersion)	Finds all states of the given workflow version.
List<WorkflowState>	getAllForActiveVersion(IEntityContext ec, Projekt project)	Finds all states of the active workflow version of the given project.
WorkflowState	getByUuid(IEntityContext ec, WorkflowVersion workflowVersion, UUID uuid)	Finds the state with the given UUID contained in the given workflow version.
Set<de.xima.cmn.dao.interfaces.IEntity<Long>>	getEntityRefs(IEntityContext ec, WorkflowState state)	Returns a set of entities that reference the given entity and depend on it.
WorkflowState	getOrCreateSystemState(IEntityContext ec, WorkflowVersion workflowVersion, EWorkflowStateType type)	Finds the given built-in workflow state.
protected IFCDaoActionHook<WorkflowState>	getPreActionHook()
protected static void	initLazy(WorkflowState state)

Methods inherited from class GenericDao

getPostActionHook, read

Methods inherited from class de.xima.cmn.dao.AbstractDao

all, bulkDelete, bulkUpdate, cb, checkLockingVersion, cq, create, create, delete, delete, deleteAll, executePagedDaoAction, getAttributes, getAttributes, getSingleAttributes, getSingleAttributes, getTransactionHandler, notifyListener, notifyListener, read, registerListener, registerListener, registerListener, resultTotalCount, setTransactionHandler, singleElement, unregisterListener, unregisterListener, unregisterListener, update, update

Methods inherited from class Object

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

Methods inherited from interface de.xima.cmn.dao.interfaces.IAbstractDao

all, bulkDelete, bulkUpdate, checkLockingVersion, create, create, delete, delete, deleteAll, executePagedDaoAction, getAttributes, getAttributes, getSingleAttributes, getSingleAttributes, getTransactionHandler, read, registerListener, registerListener, registerListener, resultTotalCount, setTransactionHandler, singleElement, unregisterListener, unregisterListener, unregisterListener, update, update

Methods inherited from interface IGenericDao

count, createOrUpdate, findAll, findSingle, read

Constructor Details

WorkflowStateDao

public WorkflowStateDao()

Creates a new instance of this DAO. Normally you should use the singleton instance provided by DaoProvider.WORKFLOWSTATE_DAO.

Method Details

getPreActionHook

protected IFCDaoActionHook<WorkflowState> getPreActionHook()

Overrides:

getPreActionHook in class GenericDao<WorkflowState>

createDefaultStates

@Deprecated
public List<WorkflowState> createDefaultStates()

Deprecated.

use createDefaultStates(Locale)

Description copied from interface: IWorkflowStateDao

Creates the system default workflow states

Specified by:

createDefaultStates in interface IWorkflowStateDao

Returns:

list of system default states

createDefaultStates

public List<WorkflowState> createDefaultStates(Locale locale)

Description copied from interface: IWorkflowStateDao

Creates the system default workflow states

Specified by:

createDefaultStates in interface IWorkflowStateDao

Parameters:

locale - the current locale

Returns:

list of system default states

getAllByWorkflowVersion

public List<WorkflowState> getAllByWorkflowVersion(IEntityContext ec,
 Projekt project,
 long versionNumber)

Description copied from interface: IWorkflowStateDao

Finds all states of the given workflow version.

Specified by:

getAllByWorkflowVersion in interface IWorkflowStateDao

Parameters:

ec - Entity context for accessing the database.

project - Project which contains the workflow version.

versionNumber - Version number of the workflow version, must belong to the given project.

Returns:

A list of all WorkflowState contained in the given workflow version.

getAllByWorkflowVersion

public List<WorkflowState> getAllByWorkflowVersion(IEntityContext ec,
 WorkflowVersion workflowVersion)

Description copied from interface: IWorkflowStateDao

Finds all states of the given workflow version.

Specified by:

getAllByWorkflowVersion in interface IWorkflowStateDao

Parameters:

ec - Entity context for accessing the database.

workflowVersion - Workflow version for which to retrieve the states.

Returns:

A list of all WorkflowState contained in the given workflow version.

getAllForActiveVersion

public List<WorkflowState> getAllForActiveVersion(IEntityContext ec,
 Projekt project)

Description copied from interface: IWorkflowStateDao

Finds all states of the active workflow version of the given project.

Specified by:

getAllForActiveVersion in interface IWorkflowStateDao

Parameters:

ec - Entity context for accessing the database.

project - Project which contains the workflow version.

Returns:

A list of all WorkflowState contained in the active workflow version of the given project.

getByUuid

public WorkflowState getByUuid(IEntityContext ec,
 WorkflowVersion workflowVersion,
 UUID uuid)

Description copied from interface: IWorkflowStateDao

Finds the state with the given UUID contained in the given workflow version. Note that the WorkflowState.getUuid() is unique only within all states of a certain workflow version.

Specified by:

getByUuid in interface IWorkflowStateDao

Parameters:

ec - Entity context for accessing the database.

workflowVersion - The workflow version for which to retrieve the state.

uuid - The UUID of the workflow state to retrieve.

Returns:

A workflow state with the given UUID that is contained in the given workflow version, or null if no such state exists.

getEntityRefs

public Set<de.xima.cmn.dao.interfaces.IEntity<Long>> getEntityRefs(IEntityContext ec,
 WorkflowState state)

Description copied from interface: IGenericDao

Returns a set of entities that reference the given entity and depend on it. An entity can usually not be deleted if it is still being referenced by and depended on by other entities.

Specified by:

getEntityRefs in interface IGenericDao<WorkflowState>

Overrides:

getEntityRefs in class GenericDao<WorkflowState>

Parameters:

ec - entity context for database transactions.

state - to get references for.

Returns:

a set of entities that reference the given entity and depend on it.

getOrCreateSystemState

public WorkflowState getOrCreateSystemState(IEntityContext ec,
 WorkflowVersion workflowVersion,
 EWorkflowStateType type)

Description copied from interface: IWorkflowStateDao

Finds the given built-in workflow state. Creates it if it does not exist yet.

Specified by:

getOrCreateSystemState in interface IWorkflowStateDao

Parameters:

ec - Entity context for accessing the database.

workflowVersion - Workflow version with states to search.

type - Workflow state type to find.

Returns:

The state with the given type.

initLazy

protected static void initLazy(WorkflowState state)