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

Author:

XIMA MEDIA GmbH

Field Summary

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

entityClass

Constructor Summary

Constructors

Constructor	Description
RolleAPI()

Method Summary

Modifier and Type	Method	Description
Rolle	addModulToRolle(UserContext uc, Rolle rolle, Modul newModul)	Method for adding a module to a existing role.
Rolle	getAdminRolle(UserContext uc, Mandant mandant)	Method for determining a admin role of a client.
Rolle	getByUUID(UserContext uc, Mandant client, String uuid)	Returns the role with the given UUID
Rolle	getByUUID(UserContext uc, Mandant client, UUID uuid)	Returns the role with the given UUID
List<Rolle>	getRollenByModul(UserContext uc, Modul modul)	Method for determining all roles by a module.

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

RolleAPI

public RolleAPI()

Method Detail

getRollenByModul

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

Method for determining all roles by a module.

Parameters:

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

modul - Modul whose roles are to be determined.

Returns:

List of Rolles which were found.

Since:

2.4.3

getAdminRolle

public Rolle getAdminRolle(UserContext uc,
                           Mandant mandant)

Method for determining a admin role of a client.

Parameters:

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

mandant - Mandant whose admin role is wanted.

Returns:

Rolle the client's admin.

Since:

2.4.3

getByUUID

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

Returns the role with the given UUID

Parameters:

uc - UserContext to use

client - Mandant context in which to look for role

uuid - String UUID of the role

Returns:

Rolle for the given UUID and client

Since:

6.x.x

getByUUID

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

Returns the role with the given UUID

Parameters:

uc - UserContext to use

client - Mandant context in which to look for role

uuid - UUID UUID of the role

Returns:

Rolle for the given UUID and client

Since:

6.x.x

addModulToRolle

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

Method for adding a module to a existing role.

Parameters:

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

rolle - Rolle to which the module should be added.

newModul - Modul which should be added.

Returns:

Rolle with the added Modul.

Since:

2.4.3