Package de.xima.fc.handler.interfaces.entity

Interface IMandantHandler

All Superinterfaces:

IAPIHandler, IGenericHandler, Serializable

All Known Implementing Classes:

MandantHandler

public interface IMandantHandler
extends IGenericHandler

Method Summary

Modifier and Type	Method	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)
Mandant	getByUUID(UserContext uc, UUID uuid)
@NotNull Map<String,String>	getCustomAttributes(UserContext uc, Mandant client)	Gets the custom properties of this client.
boolean	isCreationAllowed(UserContext uc, Mandant mandant)

Methods inherited from interface de.xima.fc.com.interfaces.IAPIHandler

getName

Methods inherited from interface de.xima.fc.handler.interfaces.entity.IGenericHandler

create, create, delete, delete, deleteBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, update, update

Method Detail

getByName

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:

6.0.1

getAllByName

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:

6.0.1

getCustomAttributes

@NotNull
@NotNull Map<String,String> getCustomAttributes(UserContext uc,
                                                      Mandant client)

Gets the custom properties of this client. This method is needed when the map of the custom properties hasn't yet been initialized.

Parameters:

uc - User context for database transactions.

client - the client to get the custom properties for.

Returns:

a map of all the custom properties of the client.

Since:

8.0.0

isCreationAllowed

boolean isCreationAllowed(UserContext uc,
                          Mandant mandant)

getByUUID

Mandant getByUUID(UserContext uc,
                  String uuid)

getByUUID

Mandant getByUUID(UserContext uc,
                  UUID uuid)