Package de.xima.fc.dao.impl
Class WorkflowVersionDao
- java.lang.Object
-
- de.xima.cmn.dao.AbstractDao<T,Long,IEntityContext>
-
- de.xima.fc.dao.impl.GenericDao<E>
-
- de.xima.fc.dao.impl.ProjektDependentBaseDao<WorkflowVersion>
-
- de.xima.fc.dao.impl.WorkflowVersionDao
-
- All Implemented Interfaces:
de.xima.cmn.dao.interfaces.IAbstractDao<WorkflowVersion,Long,IEntityContext>
,IGenericDao<WorkflowVersion>
,IProjektDependentBaseDao<WorkflowVersion>
,IWorkflowVersionDao
public class WorkflowVersionDao extends ProjektDependentBaseDao<WorkflowVersion> implements IWorkflowVersionDao
The default implementation ofIWorkflowVersionDao
that can be accessed viaDaoProvider
.- Since:
- 7.0.0
- Author:
- XIMA MEDIA GmbH
-
-
Constructor Summary
Constructors Constructor Description WorkflowVersionDao()
Creates a new instance of this DAO.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description WorkflowVersion
createNewWorkflowVersion(Projekt project, long versionNumber)
Creates a new workflow version with the default workflow states and an empty process, but does not persist it yet.void
deleteExistingVersion(IEntityContext ec, WorkflowVersion workflowVersion)
Delete an existing (persisted) workflow version.long
findNewVersionNumber(IEntityContext ec, Projekt project)
Finds a version number for a new version entity.WorkflowVersion
getActiveByProject(IEntityContext ec, Projekt project)
Finds the active workflow version for the given project.WorkflowVersion
getByVersionNumber(IEntityContext ec, Projekt project, long versionNumber)
Finds the workflow version with the given version number, if such a version exists.Set<de.xima.cmn.dao.interfaces.IEntity<Long>>
getEntityRefs(IEntityContext ec, WorkflowVersion entity)
Returns a set of entities that reference the given entity and depend on it.protected IFCDaoActionHook<WorkflowVersion>
getPreActionHook()
WorkflowVersion
loadFullVersion(IEntityContext ec, long workflowVersionId)
Loads the workflow version with the given entity and all associated entities (makes sure lazy associations are initiated).WorkflowVersion
replaceVersion(IEntityContext ec, WorkflowVersion oldWorkflowVersion, WorkflowVersion newWorkflowVersion)
Replaces the given old workflow version with the data of the new workflow version.WorkflowVersion
saveVersion(IEntityContext ec, WorkflowVersion workflowVersion)
Saves the workflow version.-
Methods inherited from class de.xima.fc.dao.impl.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 java.lang.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 de.xima.fc.dao.interfaces.IGenericDao
count, findAll, findSingle, read
-
-
-
-
Constructor Detail
-
WorkflowVersionDao
public WorkflowVersionDao()
Creates a new instance of this DAO. Normally you should use the singleton instance provided byDaoProvider.WORKFLOWVERSION_DAO
.
-
-
Method Detail
-
createNewWorkflowVersion
public WorkflowVersion createNewWorkflowVersion(Projekt project, long versionNumber)
Description copied from interface:IWorkflowVersionDao
Creates a new workflow version with the default workflow states and an empty process, but does not persist it yet.- Specified by:
createNewWorkflowVersion
in interfaceIWorkflowVersionDao
- Parameters:
project
- Project for which to create a new version.versionNumber
- Version number of the workflow version.- Returns:
- A new, non-persisted workflow version.
-
findNewVersionNumber
public long findNewVersionNumber(IEntityContext ec, Projekt project)
Description copied from interface:IWorkflowVersionDao
Finds a version number for a new version entity. It is guaranteed that this number is different from all version numbers of theProjekt.getWorkflowVersions()
of the given project.- Specified by:
findNewVersionNumber
in interfaceIWorkflowVersionDao
- Parameters:
ec
- The current entity context to use for interacting with the database.project
- The project with workflow versions for which a new version number is sought.- Returns:
- A new version number different from all version of the given project.
-
getActiveByProject
public WorkflowVersion getActiveByProject(IEntityContext ec, Projekt project)
Description copied from interface:IWorkflowVersionDao
Finds the active workflow version for the given project. Creates a new workflow version when no version exists yet.- Specified by:
getActiveByProject
in interfaceIWorkflowVersionDao
- Parameters:
ec
- The current entity context to use for interacting with the database.project
- The project for which to find the active workflow version.- Returns:
- The currently active workflow version of the given project. Returns
null
when the project does not use the new workflow.
-
replaceVersion
public WorkflowVersion replaceVersion(IEntityContext ec, WorkflowVersion oldWorkflowVersion, WorkflowVersion newWorkflowVersion)
Description copied from interface:IWorkflowVersionDao
Replaces the given old workflow version with the data of the new workflow version. Makes sure to persist all processes, tasks, triggers, and nodes as well.When
oldWorkflowVersion
isnull
, thenewWorkflowVersion
will be created. WhennewWorkflowVersion
isnull
, theoldWorkflowVersion
will be deleted.- Specified by:
replaceVersion
in interfaceIWorkflowVersionDao
- Parameters:
ec
- The current entity context to use for interacting with the database.oldWorkflowVersion
- Old workflow version to replace.newWorkflowVersion
- New workflow version to replace the old one.- Returns:
- The updated workflow version.
-
saveVersion
public WorkflowVersion saveVersion(IEntityContext ec, WorkflowVersion workflowVersion)
Description copied from interface:IWorkflowVersionDao
Saves the workflow version. Makes sure to persist all processes, tasks, triggers, and nodes as well.- Specified by:
saveVersion
in interfaceIWorkflowVersionDao
- Parameters:
ec
- The current entity context to use for interacting with the database.workflowVersion
- A workflow version to persist.- Returns:
- The newly persisted workflow version.
-
loadFullVersion
public WorkflowVersion loadFullVersion(IEntityContext ec, long workflowVersionId)
Description copied from interface:IWorkflowVersionDao
Loads the workflow version with the given entity and all associated entities (makes sure lazy associations are initiated).- Specified by:
loadFullVersion
in interfaceIWorkflowVersionDao
- Parameters:
ec
- The current entity context to use for interacting with the database.workflowVersionId
- ID of the workflow version to load.- Returns:
- The workflow version with the given ID;
null
when no such version exists.
-
deleteExistingVersion
public void deleteExistingVersion(IEntityContext ec, WorkflowVersion workflowVersion)
Description copied from interface:IWorkflowVersionDao
Delete an existing (persisted) workflow version. Makes sure to delete all processes, tasks, triggers, and nodes as well.- Specified by:
deleteExistingVersion
in interfaceIWorkflowVersionDao
- Parameters:
ec
- The current entity context to use for interacting with the database.workflowVersion
- A persisted workflow version to delete.
-
getByVersionNumber
public WorkflowVersion getByVersionNumber(IEntityContext ec, Projekt project, long versionNumber)
Description copied from interface:IWorkflowVersionDao
Finds the workflow version with the given version number, if such a version exists.- Specified by:
getByVersionNumber
in interfaceIWorkflowVersionDao
- Parameters:
ec
- The current entity context to use for interacting with the database.project
- The project to search for the workflow version.versionNumber
- The version number of the workflow version to find.- Returns:
- The workflow version with the given version number that belong to the given project, or
null
if no such workflow version exists.
-
getEntityRefs
public Set<de.xima.cmn.dao.interfaces.IEntity<Long>> getEntityRefs(IEntityContext ec, WorkflowVersion entity)
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 interfaceIGenericDao<WorkflowVersion>
- Overrides:
getEntityRefs
in classGenericDao<WorkflowVersion>
- Parameters:
ec
- entity context for database transactions.entity
- to get references for.- Returns:
- a set of entities that reference the given entity and depend on it.
-
getPreActionHook
protected IFCDaoActionHook<WorkflowVersion> getPreActionHook()
- Overrides:
getPreActionHook
in classGenericDao<WorkflowVersion>
-
-