de.xima.fc.api.entity

Class RolleAPI

java.lang.Object

de.xima.fc.api.ASubAPI

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

de.xima.fc.api.entity.RolleAPI

public class RolleAPI
extends AEntityAPI<Rolle>

API-Klassse zur Manipulation von Rolle-Entitäten

Author:

Michael Kohlsche

Field Summary

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

entityClass

Constructor Summary

Constructors

Constructor and Description
RolleAPI()

Method Summary

Methods

Modifier and Type	Method and Description
Rolle	addModulToRolle(UserContext uc, Rolle rolle, Modul newModul) Methode zum Hinzufügen eines Moduls zu einer bestehenden Rolle
Rolle	getAdminRolle(UserContext uc, Mandant mandant) Methode zum Ermitteln der Adminrolle eines Mandanten
List<Rolle>	getRollenByModul(UserContext uc, Modul modul) Methode zum Ermitteln aller Rollen anhand eines Moduls.

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

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

RolleAPI

public RolleAPI()

Method Detail

getRollenByModul

public List<Rolle> getRollenByModul(UserContext uc,
                           Modul modul)

Methode zum Ermitteln aller Rollen anhand eines Moduls.

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

modul - Modul dessen Rollen ermittelt werden sollen

Returns:

List aus Rollen welche gefunden wurden

Since:

2.4.3

getAdminRolle

public Rolle getAdminRolle(UserContext uc,
                  Mandant mandant)

Methode zum Ermitteln der Adminrolle eines Mandanten

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

mandant - Mandant dessen Adminrolle gesucht ist

Returns:

Rolle des Admins des Mandanten

Since:

2.4.3

addModulToRolle

public Rolle addModulToRolle(UserContext uc,
                    Rolle rolle,
                    Modul newModul)

Methode zum Hinzufügen eines Moduls zu einer bestehenden Rolle

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

rolle - Rolle zu welcher das Modul hinzugefügt werden soll

newModul - Modul welches hinzugefügt werden soll

Returns:

Rolle mit dem hinzugefügten Modul

Since:

2.4.3