de.xima.fc.api.entity

Class ModulAPI

java.lang.Object

de.xima.fc.api.ASubAPI

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

de.xima.fc.api.entity.ModulAPI

public class ModulAPI
extends AEntityAPI<Modul>

API-Klassse zur Manipulation von Modul-Entitäten

Author:

Michael Kohlsche

Field Summary

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

entityClass

Constructor Summary

Constructors

Constructor and Description
ModulAPI()

Method Summary

Modifier and Type	Method and Description
List<Modul>	getAllByMandant(UserContext uc, Mandant mandant) Methode zum Ermitteln aller Module anhand eines Mandanten.
List<Modul>	getAllByRolle(UserContext uc, Rolle rolle) Methode zum Ermitteln aller Module anhand der Rolle.
Modul	getModulByName(UserContext uc, Mandant mandant, String name) Methode zum Ermittlen eines bestimmten Moduls anhand des Namen und zugehörigen Mandanten.

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

ModulAPI

public ModulAPI()

Method Detail

getAllByMandant

public List<Modul> getAllByMandant(UserContext uc,
                                   Mandant mandant)

Methode zum Ermitteln aller Module anhand eines Mandanten.

Parameters:

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

mandant - Mandant dessen Module ermittelt werden sollen

Returns:

List aus Modulen welche gefunden wurden @since 2.4.3

getAllByRolle

public List<Modul> getAllByRolle(UserContext uc,
                                 Rolle rolle)

Methode zum Ermitteln aller Module anhand der Rolle.

Parameters:

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

rolle - Rolle dessen Module ermittelt werden sollen

Returns:

Liste von Modulen @ Fehler beim Lesen der Daten

Since:

2.4.3

getModulByName

public Modul getModulByName(UserContext uc,
                            Mandant mandant,
                            String name)

Methode zum Ermittlen eines bestimmten Moduls anhand des Namen und zugehörigen Mandanten.

Parameters:

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

mandant - Mandant dem das Modul zugeordnet ist.

name - String des Moduls

Returns:

Modul mit dem Namen oder null, falls keine Übereinstimmung erfolgt. @