de.xima.fc.api.entity

Class StatusAPI

java.lang.Object

de.xima.fc.api.ASubAPI

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

de.xima.fc.api.entity.StatusAPI

public class StatusAPI
extends AEntityAPI<Status>

API class for manipulation of Status entities.

Author:

XIMA MEDIA GmbH

Field Summary

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

entityClass

Constructor Summary

Constructors

Constructor and Description
StatusAPI()

Method Summary

Modifier and Type	Method and Description
List<Status>	getByProjekt(UserContext uc, Projekt projekt) Method for determining all Status if a Projekt.
Status	getByUUID(UserContext uc, Projekt project, String uuid) Returns the state with the given UUID
Status	getByUUID(UserContext uc, Projekt project, UUID uuid) Returns the state with the given UUID
List<Status>	getFolgeStatus(UserContext uc, Benutzer benutzer, Projekt projekt, Status aktuellerStatus) Method for determining the List of follow-up Status which based on the committed Status and the appropriate Projekt may be set, taking into account the authority of the given Benutzer.
List<Status>	getStatusPre(UserContext uc, Status state) Retrieves the Status.getStatusPre().
Status	move(UserContext uc, Status status, int newIdxNum) Method for moving a status to the committed index.

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

create, create, delete, delete, deleteAllBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, 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

StatusAPI

public StatusAPI()

Method Detail

getByProjekt

public List<Status> getByProjekt(UserContext uc,
                                 Projekt projekt)

Method for determining all Status if a Projekt.

Parameters:

uc - UserContext the user context in which the action is to be performed.

projekt - Projekt whose Status is to be determined.

Returns:

List of Status by Projekt.

Since:

2.4.3

getFolgeStatus

public List<Status> getFolgeStatus(UserContext uc,
                                   Benutzer benutzer,
                                   Projekt projekt,
                                   Status aktuellerStatus)

Method for determining the List of follow-up Status which based on the committed Status and the appropriate Projekt may be set, taking into account the authority of the given Benutzer.

Parameters:

uc - UserContext the user context in which the action is to be performed.

benutzer - Benutzer which follow-up status should be determined.

projekt - Projekt the project in which the status change is to be executed.

aktuellerStatus - Status the current status from which the status change is to be executed.

Returns:

List of Status which are available for status change.

Since:

2.4.3

getStatusPre

public List<Status> getStatusPre(UserContext uc,
                                 Status state)

Retrieves the Status.getStatusPre().

Parameters:

uc - Current user context.

state - The state for which to get the Status.getStatusPre().

Returns:

All states that allow a state change to the given state.

getByUUID

public Status getByUUID(UserContext uc,
                        Projekt project,
                        String uuid)

Returns the state with the given UUID

Parameters:

uc - UserContext to use

project - Projekt context in which to look for the state

uuid - String UUID of the state

Returns:

Status for the given UUID and project

Since:

6.x.x

getByUUID

public Status getByUUID(UserContext uc,
                        Projekt project,
                        UUID uuid)

Returns the state with the given UUID

Parameters:

uc - UserContext to use

project - Projekt context in which to look for the state

uuid - UUID UUID of the state

Returns:

Status for the given UUID and project

Since:

6.x.x

move

public Status move(UserContext uc,
                   Status status,
                   int newIdxNum)

Method for moving a status to the committed index.

Parameters:

uc - UserContext the user context in which the action is to be performed.

status - Status which should be moved.

newIdxNum - index number of the next status.

Returns:

Status the moved status.