de.xima.fc.api.entity

Class GenericAPI

java.lang.Object

de.xima.fc.api.ASubAPI

de.xima.fc.api.entity.GenericAPI

public class GenericAPI
extends ASubAPI

Generische API-Klasse zur Manipulation von Entitäten.
Diese Klasse stellt Methoden für die grundlegende CRUD-Funktionen (Create, Read, Update, Delete) zur Verfügung.

Author:

Michael Kohlsche

Constructor Summary

Constructors

Constructor and Description
GenericAPI()

Method Summary

Modifier and Type	Method and Description
<T extends ITransferableEntity> T	create(Class<T> entityClass, UserContext uc, T entity) Methode zum Erstellen einer Entität einer bestimmten Klasse.
<T extends ITransferableEntity> T[]	create(Class<T> entityClass, UserContext uc, T[] entities) Methode zum Erstellen mehrerer Entitäten einer bestimmten Klasse.
<T extends ITransferableEntity> boolean	delete(Class<T> entityClass, UserContext uc, T entity) Methode zum Löschen einer Entität einer bestimmten Klasse.
<T extends ITransferableEntity> boolean	delete(Class<T> entityClass, UserContext uc, T[] entities) Methode zum Löschen mehrere Entitäten einer bestimmten Klasse.
<T extends ITransferableEntity> Boolean	deleteAllBy(Class<T> entityClass, UserContext uc, de.xima.cmn.criteria.QueryCriteriaManager qcm)
<T extends ITransferableEntity> Boolean	deleteById(Class<T> entityClass, UserContext uc, int id)
<T extends ITransferableEntity> List<T>	getAll(Class<T> entityClass, UserContext uc)
<T extends ITransferableEntity> List<T>	getAll(Class<T> entityClass, UserContext uc, de.xima.cmn.criteria.QueryCriteriaManager qcm) Methode zum Ermitteln aller Entitäten einer bestimmten Klasse unter Verwendung eines QueryCriteriaManagers.
<T extends ITransferableEntity> T	getBy(Class<T> entityClass, UserContext uc, de.xima.cmn.criteria.QueryCriteriaManager qcm) Methode zum Ermitteln einer Entität unter Verwendung eines QueryCriteriaManagers.
<T extends ITransferableEntity> T	getById(Class<T> entityClass, UserContext uc, int id) Methode zum Auslesen einer Entität anhand ihrer Klasse und ID.
<T extends ITransferableEntity> T	getById(UserContext uc, String entityClassName, String id) Methode zum Auslesen einer Entität anhand ihres Klassen-Namens und ihrer ID.
<T extends ITransferableEntity> int	resultTotalCount(Class<T> entityClass, UserContext uc, de.xima.cmn.criteria.QueryCriteriaManager qcm) Methode zum Ermitteln der Anzahl der gefundenen Entitäten basierend auf ihrer Klasse und eines.
<T extends ITransferableEntity> T	update(Class<T> entityClass, UserContext uc, T entity) Methode zum Aktualisieren einer Entität einer bestimmten Klasse.
<T extends ITransferableEntity> T[]	update(Class<T> entityClass, UserContext uc, T[] entities) Methode zum Erstellen mehrerer Enmtitäten einer bestimmten Klasse.

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

GenericAPI

public GenericAPI()

Method Detail

getAll

public <T extends ITransferableEntity> List<T> getAll(Class<T> entityClass,
                                                      UserContext uc,
                                                      de.xima.cmn.criteria.QueryCriteriaManager qcm)

Methode zum Ermitteln aller Entitäten einer bestimmten Klasse unter Verwendung eines QueryCriteriaManagers.

Parameters:

entityClass - ITransferableEntity-Klasse der Entitäten

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

qcm - QueryCriteriaManager mit Hilfe dessen gefiltert werden soll

Returns:

List aus ITransferableEntity welche gefunden wurden

Since:

2.4.3

create

public <T extends ITransferableEntity> T create(Class<T> entityClass,
                                                UserContext uc,
                                                T entity)

Methode zum Erstellen einer Entität einer bestimmten Klasse.

Parameters:

entityClass - ITransferableEntity-Klasse der Entität

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

entity - ITransferableEntity welche erstellt werden soll

Returns:

ITransferableEntity welche erstellt wurde @since 2.4.3 @

create

public <T extends ITransferableEntity> T[] create(Class<T> entityClass,
                                                  UserContext uc,
                                                  T[] entities)

Methode zum Erstellen mehrerer Entitäten einer bestimmten Klasse.

Parameters:

entityClass - ITransferableEntity-Klasse der Entitäten

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

entities - Array der zu erstellenden Entitäten

Returns:

Array der erstellten Entitäten @since 2.4.3

delete

public <T extends ITransferableEntity> boolean delete(Class<T> entityClass,
                                                      UserContext uc,
                                                      T entity)

Methode zum Löschen einer Entität einer bestimmten Klasse.

Parameters:

entityClass - ITransferableEntity-Klasse der Entität

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

entity - ITransferableEntity welche gelöscht werden soll

Returns:

Boolean ob das Löschen erfolgreich war oder nicht @since 2.4.3

delete

public <T extends ITransferableEntity> boolean delete(Class<T> entityClass,
                                                      UserContext uc,
                                                      T[] entities)

Methode zum Löschen mehrere Entitäten einer bestimmten Klasse.

Parameters:

entityClass - ITransferableEntity-Klasse der Entitäten

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

entities - Array der zu löschenden Entitäten

Returns:

Boolean ob das Löschen erfolgreich war oder nicht @since 2.4.3

getById

public <T extends ITransferableEntity> T getById(Class<T> entityClass,
                                                 UserContext uc,
                                                 int id)

Methode zum Auslesen einer Entität anhand ihrer Klasse und ID.

Parameters:

entityClass - ITransferableEntity-Klasse der Entität

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

id - Integer die ID der gesuchtne Entität

Returns:

ITransferableEntity die gefundene Entität @since 2.4.3

getById

public <T extends ITransferableEntity> T getById(UserContext uc,
                                                 String entityClassName,
                                                 String id)

Methode zum Auslesen einer Entität anhand ihres Klassen-Namens und ihrer ID.

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

entityClassName - String der Klassenname der gesuchten Entität

id - Integer die ID der gesuchten Entität

Returns:

ITransferableEntity die gefundene Entität @since 2.4.3

resultTotalCount

public <T extends ITransferableEntity> int resultTotalCount(Class<T> entityClass,
                                                            UserContext uc,
                                                            de.xima.cmn.criteria.QueryCriteriaManager qcm)

Methode zum Ermitteln der Anzahl der gefundenen Entitäten basierend auf ihrer Klasse und eines.

Parameters:

entityClass - ITransferableEntity-Klasse der Entitäten

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

qcm - QueryCriteriaManager mit welchem gesucht werden soll

Returns:

Integer die gefundene Anzahl an Elementen QueryCriteriaManagers

Since:

2.4.3

update

public <T extends ITransferableEntity> T[] update(Class<T> entityClass,
                                                  UserContext uc,
                                                  T[] entities)

Methode zum Erstellen mehrerer Enmtitäten einer bestimmten Klasse.

Parameters:

entityClass - ITransferableEntity-Klasse der Entitäten

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

entities - Array der zu erstellenden Entitäten

Returns:

Array der erstellten Entitäten @since 2.4.3

update

public <T extends ITransferableEntity> T update(Class<T> entityClass,
                                                UserContext uc,
                                                T entity)

Methode zum Aktualisieren einer Entität einer bestimmten Klasse.

Parameters:

entityClass - ITransferableEntity-Klasse der Entität

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

entity - ITransferableEntity welche aktualisiert werden soll

Returns:

ITransferableEntity die aktualisierte Entität @since 2.4.3

getBy

public <T extends ITransferableEntity> T getBy(Class<T> entityClass,
                                               UserContext uc,
                                               de.xima.cmn.criteria.QueryCriteriaManager qcm)

Methode zum Ermitteln einer Entität unter Verwendung eines QueryCriteriaManagers.

Parameters:

entityClass - ITransferableEntity-Klasse der Entität

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

qcm - der QueryCriteriaManager welcher zur Suche verwendet werden soll

Returns:

die gefundene Entität @since 2.4.3

deleteAllBy

public <T extends ITransferableEntity> Boolean deleteAllBy(Class<T> entityClass,
                                                           UserContext uc,
                                                           de.xima.cmn.criteria.QueryCriteriaManager qcm)

deleteById

public <T extends ITransferableEntity> Boolean deleteById(Class<T> entityClass,
                                                          UserContext uc,
                                                          int id)

getAll

public <T extends ITransferableEntity> List<T> getAll(Class<T> entityClass,
                                                      UserContext uc)