Package 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 class for manipulation of Modul entities.

Author:

XIMA MEDIA GmbH

Field Summary

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

entityClass

Constructor Summary

Constructors

Constructor	Description
ModulAPI()

Method Summary

Modifier and Type	Method	Description
List<Modul>	getAllByMandant(UserContext uc, Mandant mandant)	Method for determining all modules by a client.
List<Modul>	getAllByRolle(UserContext uc, Rolle rolle)	Method for determining all modules by a role.
Modul	getModulByName(UserContext uc, Mandant mandant, String name)	Method for determining of a defined module by the name and associated client.

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

ModulAPI

public ModulAPI()

Method Detail

getAllByMandant

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

Method for determining all modules by a client.

Parameters:

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

mandant - Mandant whose modules are to be determined.

Returns:

List of Modules which were found.

Since:

2.4.3

getAllByRolle

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

Method for determining all modules by a role.

Parameters:

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

rolle - Rolle whose modules are to be determined.

Returns:

List of Modules.

Since:

2.4.3

getModulByName

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

Method for determining of a defined module by the name and associated client.

Parameters:

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

mandant - Mandant to which the module is assigned.

name - String of the modules.

Returns:

Modul with the name or null, if no match occurs.