Package 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 ofMandant
entities.- Author:
- XIMA MEDIA GmbH
-
-
Field Summary
-
Fields inherited from class de.xima.fc.api.entity.AEntityAPI
entityClass
-
-
Constructor Summary
Constructors Constructor Description MandantAPI()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<Mandant>
getAllByName(UserContext uc, String name)
Method for determining allMandant
s by name (case insensitive).Mandant
getByName(UserContext uc, String name)
Method for determining aMandant
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)
Method for checking if the creation of aMandant
is allowed.-
Methods inherited from class de.xima.fc.api.entity.AEntityAPI
create, create, delete, delete, deleteAllBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getEntityRefs, getPagedResult, getSingleAttributes, getSingleAttributes, resultTotalCount, resultTotalCount, update, update
-
Methods inherited from class de.xima.fc.api.ASubAPI
getHandlerProvider
-
-
-
-
Method Detail
-
getByName
public Mandant getByName(UserContext uc, String name)
Method for determining aMandant
by his name (case insensitive).- Parameters:
uc
-UserContext
the user context in which the action is to be performed.name
-String
the name of theMandant
(case insensitive).- Returns:
Mandant
which was searched.- Since:
- 2.4.3
-
getAllByName
public List<Mandant> getAllByName(UserContext uc, String name)
Method for determining allMandant
s 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
ofMandant
which were found.- Since:
- 2.4.3
-
getCustomAttributes
@NotNull public @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
-
getByUUID
public Mandant getByUUID(UserContext uc, String uuid)
-
getByUUID
public Mandant getByUUID(UserContext uc, UUID uuid)
-
isCreationAllowed
public boolean isCreationAllowed(UserContext uc, Mandant mandant)
Method for checking if the creation of aMandant
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.
-
-