de.xima.fc.api.entity

Class AktionAPI

java.lang.Object

de.xima.fc.api.ASubAPI

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

de.xima.fc.api.entity.AktionAPI

public class AktionAPI
extends AEntityAPI<Aktion>

API class for manipulation of Aktion entities.

Author:

Michael Kohlsche

Field Summary

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

entityClass

Constructor Summary

Constructors

Constructor and Description
AktionAPI()

Method Summary

Modifier and Type	Method and Description
List<Aktion>	getAllByStatus(UserContext uc, Status status) Method for loading all Aktion of a status.
Aktion	getByUUID(UserContext uc, Status state, String uuid) Returns the action with the given UUID
Aktion	getByUUID(UserContext uc, Status state, UUID uuid) Returns the action with the given UUID
List<Aktion>	getFolgeAktionen(UserContext uc, Aktion aktion) Method for loading all follow-up actions of a committed action.
List<Aktion>	getPrevAktionen(UserContext uc, Aktion aktion, Class<? extends IProcessing> verarbeitungsInterface) Method for loading all predecessor actions of a committed action, which implement the passed interface.
BasicRefResult	isAktionMoveable(UserContext uc, Aktion aktion, int targetIdx) Method for checking if the committed action is movable.
Aktion	move(UserContext uc, Aktion aktion, int targetIdx) Method for moving a action to the committed index.

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

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

AktionAPI

public AktionAPI()

Method Detail

getAllByStatus

public List<Aktion> getAllByStatus(UserContext uc,
                                   Status status)

Method for loading all Aktion of a status. This must be used in the Frontend-Server to pick up the lazy-initialized list of the Aktion.

Parameters:

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

status - which Aktion should be loaded.

Returns:

List of Aktion

Since:

2.4.3

getFolgeAktionen

public List<Aktion> getFolgeAktionen(UserContext uc,
                                     Aktion aktion)

Method for loading all follow-up actions of a committed action.

Parameters:

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

aktion - Aktion for which the follow-up actions should be determined.

Returns:

The follow-up actions.

Since:

3.1.6

getPrevAktionen

public List<Aktion> getPrevAktionen(UserContext uc,
                                    Aktion aktion,
                                    Class<? extends IProcessing> verarbeitungsInterface)

Method for loading all predecessor actions of a committed action, which implement the passed interface.

Parameters:

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

aktion - Aktion for which the previous actions should be determined.

verarbeitungsInterface - The class which implement the interface IProcessing.

Returns:

The predecessor actions.

Since:

3.1.6

getByUUID

public Aktion getByUUID(UserContext uc,
                        Status state,
                        String uuid)

Returns the action with the given UUID

Parameters:

uc - UserContext to use

state - Status context in which to look for resource

uuid - String UUID of the action

Returns:

Aktion for the given UUID and state

Since:

6.x.x

getByUUID

public Aktion getByUUID(UserContext uc,
                        Status state,
                        UUID uuid)

Returns the action with the given UUID

Parameters:

uc - UserContext to use

state - Status context in which to look for resource

uuid - UUID UUID of the action

Returns:

Aktion for the given UUID and state

Since:

6.x.x

isAktionMoveable

public BasicRefResult isAktionMoveable(UserContext uc,
                                       Aktion aktion,
                                       int targetIdx)

Method for checking if the committed action is movable.

Parameters:

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

aktion - Aktion which should be moved.

targetIdx - Integer index in which position should the action moved.

Returns:

BasicRefResult with the referenced IDs and success flag.

move

public Aktion move(UserContext uc,
                   Aktion aktion,
                   int targetIdx)

Method for moving a action to the committed index.

Parameters:

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

aktion - Aktion which should be moved.

targetIdx - Integer index in which position should the action moved.

Returns:

Aktion which is moved.