de.xima.fc.api.entity

Class AEntityAPI<T extends ITransferableEntity>

java.lang.Object

de.xima.fc.api.ASubAPI

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

Type Parameters:

T - Typ der Entität, welche von AbstractLockableEntity erbt.

Direct Known Subclasses:

AktionAPI, AttachmentAPI, BedingungAPI, BenutzerAPI, BenutzerGruppeAPI, DatenbankZugriffAPI, DatenquelleAPI, EntityberechtigungAPI, FormEingangAPI, FormElementAPI, FormVersionAPI, FrontendServerAPI, FSConnectionAPI, LDAPAbfrageAPI, LDAPGruppeAPI, LDAPZugriffAPI, MandantAPI, MandantFrontendServerAPI, MandantRessourcenAPI, ModulAPI, PostfachAPI, ProjektAPI, ProjektRessourcenAPI, ProjektZaehlerAPI, ProjektZaehlerDatenAPI, ProtokollAPI, RolleAPI, StatusAPI, TextbausteinAPI, VorgangAPI

public abstract class AEntityAPI<T extends ITransferableEntity>
extends ASubAPI

Abstrakte Klasse mit verschiedenen CRUD-Operationen auf Entitäten des Typs ITransferableEntity

Author:

Michael Kohlsche

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<T>	entityClass

Constructor Summary

Constructors

Constructor and Description
AEntityAPI() Instantiates a new a entity api.

Method Summary

Modifier and Type	Method and Description
T	create(UserContext uc, T entity) Methode zum Erstellen einer Entität.
T[]	create(UserContext uc, T[] entities) Methode zum Erzeugen mehrerer Entität.
Boolean	delete(UserContext uc, T entity) Methode zum Löschen einer Entität.
Boolean	delete(UserContext uc, T[] entities) Methode zum Löschen mehrerer Entitäten.
Boolean	deleteAllBy(UserContext uc, de.xima.cmn.criteria.QueryCriteriaManager qcm) Methode zum Löschen von Entitäten unter Verwendung eines QueryCriteriaManagers.
Boolean	deleteById(UserContext uc, int id) Methode zum Löschen einer Entität anhand ihrere ID.
List<T>	getAll(UserContext uc) Methode zum Ermitteln aller im Benutzerkontext verfügbaren Entitäten.
List<T>	getAllBy(UserContext uc, de.xima.cmn.criteria.QueryCriteriaManager qcm) Methode zum Ermitteln aller Entitäten unter Verwendung eines QueryCriteriaManagers.
T	getBy(UserContext uc, de.xima.cmn.criteria.QueryCriteriaManager qcm) Methode zum Ermitteln einer Entität unter Verwendung eines QueryCriteriaManagers.
T	getById(UserContext uc, int id) Methode zum Ermitteln einer Entität anhand ihrer ID.
int	resultTotalCount(UserContext uc, de.xima.cmn.criteria.QueryCriteriaManager qcm) Methode zum Ermitteln der Treffer-Anzahl beim Suchen nach Entitäten unter Verwendung eines.
T	update(UserContext uc, T entity) Methode zum Aktualisieren einer Entität.
T[]	update(UserContext uc, T[] entities) Methode zum Aktualisieren mehrerer Entitäten.

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

Field Detail

entityClass

protected Class<T extends ITransferableEntity> entityClass

Constructor Detail

AEntityAPI

public AEntityAPI()

Instantiates a new a entity api.

Method Detail

create

public T create(UserContext uc,
                T entity)

Methode zum Erstellen einer Entität.

Parameters:

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

entity - die zu erstellende Entität

Returns:

die erstellte Entität @

create

public T[] create(UserContext uc,
                  T[] entities)

Methode zum Erzeugen mehrerer Entität.

Parameters:

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 @

update

public T update(UserContext uc,
                T entity)

Methode zum Aktualisieren einer Entität.

Parameters:

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

entity - die zu aktualisierende Entität

Returns:

die aktualisierte Entität @

delete

public Boolean delete(UserContext uc,
                      T entity)

Methode zum Löschen einer Entität.

Parameters:

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

entity - die zu löschende Entität

Returns:

Boolean ob das Löschen erfolgreich war @

delete

public Boolean delete(UserContext uc,
                      T[] entities)

Methode zum Löschen mehrerer Entitäten.

Parameters:

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

entities - ein Array der zu löschenden Entitäten

Returns:

Boolean ob das Löschen erfolgreich war @

update

public T[] update(UserContext uc,
                  T[] entities)

Methode zum Aktualisieren mehrerer Entitäten.

Parameters:

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

entities - ein Array der zu aktualisierenden Entitäten

Returns:

Array mit den aktuelisierten Entitäten @

getAll

public List<T> getAll(UserContext uc)

Methode zum Ermitteln aller im Benutzerkontext verfügbaren Entitäten.

Parameters:

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

Returns:

List der verfügbaren Entitäten @

getById

public T getById(UserContext uc,
                 int id)

Methode zum Ermitteln einer Entität anhand ihrer ID.

Parameters:

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

id - Integer die ID der Entität

Returns:

die gesuchte Entität @

deleteById

public Boolean deleteById(UserContext uc,
                          int id)

Methode zum Löschen einer Entität anhand ihrere ID.

Parameters:

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

id - Integer die ID der zu löschendne Entität

Returns:

Boolean ob das Löschen erfolgreich war

resultTotalCount

public int resultTotalCount(UserContext uc,
                            de.xima.cmn.criteria.QueryCriteriaManager qcm)

Methode zum Ermitteln der Treffer-Anzahl beim Suchen nach Entitäten unter Verwendung eines.

Parameters:

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

qcm - der QueryCriteriaManager welcher zur Suche verwendet werden soll

Returns:

Integer die gefundene Anzahl an Entitäten

getBy

public T getBy(UserContext uc,
               de.xima.cmn.criteria.QueryCriteriaManager qcm)

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

Parameters:

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

getAllBy

public List<T> getAllBy(UserContext uc,
                        de.xima.cmn.criteria.QueryCriteriaManager qcm)

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

Parameters:

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

qcm - der QueryCriteriaManager welcher bei der Suche verwendet werden soll

Returns:

List der gefundenen Entitäten

deleteAllBy

public Boolean deleteAllBy(UserContext uc,
                           de.xima.cmn.criteria.QueryCriteriaManager qcm)

Methode zum Löschen von Entitäten unter Verwendung eines QueryCriteriaManagers.

Parameters:

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

qcm - der QueryCriteriaManager welcher beim Löschen verwendet werden soll

Returns:

Boolean ob das Löschen erfolgreich war