Package de.xima.fc.api.entity

Class BenutzerGruppeAPI

java.lang.Object

de.xima.fc.api.ASubAPI

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

de.xima.fc.api.entity.BenutzerGruppeAPI

public class BenutzerGruppeAPI
extends AEntityAPI<BenutzerGruppe>

API class for manipulation of BenutzerGruppe entities.

Author:

XIMA MEDIA GmbH

Field Summary

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

entityClass

Constructor Summary

Constructors

Constructor	Description
BenutzerGruppeAPI()

Method Summary

Modifier and Type	Method	Description
List<BenutzerGruppe>	getBenutzerGruppenUsageRightByStatus(UserContext uc, Status state)	Method for finding all Status.getBenutzerGruppenUsageRight() for a given state.
List<BenutzerGruppe>	getByBenutzer(UserContext uc, Benutzer benutzer)	Method for determining all BenutzerGruppe of a Benutzer.
List<BenutzerGruppe>	getByMandant(UserContext uc, Mandant mandant)	Method for determining all BenutzerGruppe of a Mandant.
List<BenutzerGruppe>	getByProjekt(UserContext uc, Projekt projekt)	Method for determining all BenutzerGruppe of a Projekt.
BenutzerGruppe	getByUUID(UserContext uc, Mandant client, String uuid)	Returns the user group with the given UUID string
BenutzerGruppe	getByUUID(UserContext uc, Mandant client, UUID uuid)	Returns the user group with the given UUID
List<BenutzerGruppe>	getEditorgruppenByProjekt(UserContext uc, Projekt projekt)	Method for determining all BenutzerGruppe of a Projekt.

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

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

BenutzerGruppeAPI

public BenutzerGruppeAPI()

Method Detail

getByProjekt

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

Method for determining all BenutzerGruppe of a Projekt. This must be used in the Frontend-Server to pick up the lazy-initialized list of the BenutzerGruppe.

Parameters:

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

projekt - Projekt for which the BenutzerGruppe to be determined.

Returns:

List of BenutzerGruppe.

Since:

2.4.3

getEditorgruppenByProjekt

public List<BenutzerGruppe> getEditorgruppenByProjekt(UserContext uc,
                                                      Projekt projekt)

Method for determining all BenutzerGruppe of a Projekt.

Parameters:

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

projekt - Projekt for which the BenutzerGruppe to be determined.

Returns:

List of BenutzerGruppe.

getBenutzerGruppenUsageRightByStatus

public List<BenutzerGruppe> getBenutzerGruppenUsageRightByStatus(UserContext uc,
                                                                 Status state)

Method for finding all Status.getBenutzerGruppenUsageRight() for a given state.

Parameters:

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

state - The state for which to retrieve the allowed user groups.

Returns:

All user groups whose users are allowed to perform a state change to the given state.

getByBenutzer

public List<BenutzerGruppe> getByBenutzer(UserContext uc,
                                          Benutzer benutzer)

Method for determining all BenutzerGruppe of a Benutzer.

Parameters:

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

benutzer - Benutzer for which the BenutzerGruppe to be determined.

Returns:

List of BenutzerGruppe.

getByMandant

public List<BenutzerGruppe> getByMandant(UserContext uc,
                                         Mandant mandant)

Method for determining all BenutzerGruppe of a Mandant. This must be used in the Frontend-Server to pick up the lazy-initialized list of the BenutzerGruppe.

Parameters:

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

mandant - Mandant for which the BenutzerGruppe to be determined.

Returns:

List of BenutzerGruppe.

Since:

2.4.3

getByUUID

public BenutzerGruppe getByUUID(UserContext uc,
                                Mandant client,
                                String uuid)

Returns the user group with the given UUID string

Parameters:

uc - UserContext to use

client - Mandant context in which to look for user group

uuid - String UUID string of the user group

Returns:

BenutzerGruppe for the given UUID and client

Since:

6.x.x

getByUUID

public BenutzerGruppe getByUUID(UserContext uc,
                                Mandant client,
                                UUID uuid)

Returns the user group with the given UUID

Parameters:

uc - UserContext to use

client - Mandant context in which to look for user group

uuid - UUID UUID of the user group

Returns:

BenutzerGruppe for the given UUID and client

Since:

6.x.x