Package de.xima.fc.api.entity

Class WorkflowVersionAPI

java.lang.Object

de.xima.fc.api.ASubAPI

de.xima.fc.api.entity.AEntityAPI<WorkflowVersion>

de.xima.fc.api.entity.WorkflowVersionAPI

public class WorkflowVersionAPI
extends AEntityAPI<WorkflowVersion>

API class for reading and writing WorkflowVersion entities.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Field Summary

Fields inherited from class de.xima.fc.api.entity.AEntityAPI

entityClass

Constructor Summary

Constructors

Constructor	Description
WorkflowVersionAPI()

Method Summary

Modifier and Type	Method	Description
WorkflowVersion	getActiveByProject(UserContext uc, Projekt project)	Finds the active workflow version for the given project.
WorkflowVersion	getByVersionNumber(UserContext uc, Projekt project, long versionNumber)	Finds the workflow version with the given version number, if such a version exists.

Methods inherited from class de.xima.fc.api.entity.AEntityAPI

create, create, delete, delete, deleteAllBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getEntityRefs, getPagedResult, getSingleAttributes, getSingleAttributes, resultTotalCount, resultTotalCount, update, update

Methods inherited from class de.xima.fc.api.ASubAPI

getHandlerProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowVersionAPI

public WorkflowVersionAPI()

Method Detail

getActiveByProject

public WorkflowVersion getActiveByProject(UserContext uc,
                                          Projekt project)

Finds the active workflow version for the given project. Creates a new workflow version when no version exists yet.

Parameters:

uc - The current user 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.

getByVersionNumber

public WorkflowVersion getByVersionNumber(UserContext uc,
                                          Projekt project,
                                          long versionNumber)

Finds the workflow version with the given version number, if such a version exists.

Parameters:

uc - The current user 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.