de.xima.fc.api.entity

Class MandantAPI

java.lang.Object

de.xima.fc.api.ASubAPI

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

de.xima.fc.api.entity.MandantAPI

public class MandantAPI
extends AEntityAPI<Mandant>

API class for manipulation of Mandant entities.

Author:

Michael Kohlsche

Field Summary

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

entityClass

Constructor Summary

Constructors

Constructor and Description
MandantAPI()

Method Summary

Modifier and Type	Method and Description
List<Mandant>	getAllByName(UserContext uc, String name) Method for determining all Mandants by name (case insensitive).
Mandant	getByName(UserContext uc, String name) Method for determining a Mandant by his name (case insensitive).
Mandant	getByUUID(UserContext uc, String uuid)
boolean	isCreationAllowed(UserContext uc, Mandant mandant) Method for checking if the creation of a Mandant is allowed.

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

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

MandantAPI

public MandantAPI()

Method Detail

getByName

public Mandant getByName(UserContext uc,
                         String name)

Method for determining a Mandant by his name (case insensitive).

Parameters:

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

name - String the name of the Mandant (case insensitive).

Returns:

Mandant which was searched.

Since:

2.4.3

getAllByName

public List<Mandant> getAllByName(UserContext uc,
                                  String name)

Method for determining all Mandants by name (case insensitive).

Parameters:

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

name - String the name which is to searched (case insensitive).

Returns:

List of Mandant which were found.

Since:

2.4.3

getByUUID

public Mandant getByUUID(UserContext uc,
                         String uuid)

isCreationAllowed

public boolean isCreationAllowed(UserContext uc,
                                 Mandant mandant)

Method for checking if the creation of a Mandant is allowed.

Parameters:

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

mandant - Mandant which is to check.

Returns:

Boolean if the creation is allowed true, otherwise false.