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 - Type of the entity, which inherits from AbstractLockableEntity.

Direct Known Subclasses:

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

public abstract class AEntityAPI<T extends ITransferableEntity>
extends ASubAPI

Abstract class with diffrent CRUD operations for entities of the type 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 entity API.

Method Summary

Modifier and Type	Method and Description
T	create(UserContext uc, T entity) Method for creating a entity.
T[]	create(UserContext uc, T[] entities) Method for creating multiple entities.
Boolean	delete(UserContext uc, T entity) Method for deleting a entity.
Boolean	delete(UserContext uc, T[] entities) Method for deleting multiple entities.
Boolean	deleteAllBy(UserContext uc, de.xima.cmn.criteria.QueryCriteriaManager qcm) Method for deleting entities using a QueryCriteriaManagers.
Boolean	deleteById(UserContext uc, Integer id)
Boolean	deleteById(UserContext uc, Long id) Method for deleting a entity by ID.
List<T>	getAll(UserContext uc) Method for determining all available entities in the user context.
List<T>	getAllBy(UserContext uc, de.xima.cmn.criteria.QueryCriteriaManager qcm) Method for determining all entities using a QueryCriteriaManagers.
T	getBy(UserContext uc, de.xima.cmn.criteria.QueryCriteriaManager qcm) Method for determining an entity using a QueryCriteriaManagers.
T	getById(UserContext uc, Integer id)
T	getById(UserContext uc, Long id) Method for determining an entity by ID.
int	resultTotalCount(UserContext uc, de.xima.cmn.criteria.QueryCriteriaManager qcm) Method for determining the number of hits when searching for entities using a QueryCriteriaManager.
T	update(UserContext uc, T entity) Method for updating a entity.
T[]	update(UserContext uc, T[] entities) Method for updating multiple entities.

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 entity API.

Method Detail

create

public T create(UserContext uc,
                T entity)

Method for creating a entity.

Parameters:

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

entity - the entity to be created.

Returns:

The created entity.

create

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

Method for creating multiple entities.

Parameters:

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

entities - a Array of the entities to be created.

Returns:

Array of the created entities.

update

public T update(UserContext uc,
                T entity)

Method for updating a entity.

Parameters:

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

entity - the entity to be update.

Returns:

The updated entity.

delete

public Boolean delete(UserContext uc,
                      T entity)

Method for deleting a entity.

Parameters:

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

entity - the entity to be deleted.

Returns:

Boolean if the deletion was successful.

delete

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

Method for deleting multiple entities.

Parameters:

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

entities - a Array of the entities to be deleted.

Returns:

Boolean if the deletion was successful.

update

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

Method for updating multiple entities.

Parameters:

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

entities - a Array of the entities to be updated.

Returns:

Array with the updated entities.

getAll

public List<T> getAll(UserContext uc)

Method for determining all available entities in the user context.

Parameters:

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

Returns:

List of the available entities.

getById

public T getById(UserContext uc,
                 Long id)

Method for determining an entity by ID.

Parameters:

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

id - Integer the ID of the entity.

Returns:

The searched entity.

getById

public T getById(UserContext uc,
                 Integer id)

deleteById

public Boolean deleteById(UserContext uc,
                          Long id)

Method for deleting a entity by ID.

Parameters:

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

id - Integer the ID of the entity to be deleted.

Returns:

Boolean if the deletion was successful.

deleteById

public Boolean deleteById(UserContext uc,
                          Integer id)

resultTotalCount

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

Method for determining the number of hits when searching for entities using a QueryCriteriaManager.

Parameters:

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

qcm - the QueryCriteriaManager which should be used for the search.

Returns:

Integer the found number of entities

getBy

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

Method for determining an entity using a QueryCriteriaManagers.

Parameters:

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

qcm - the QueryCriteriaManager which should be used for the search.

Returns:

The found entity.

getAllBy

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

Method for determining all entities using a QueryCriteriaManagers.

Parameters:

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

qcm - the QueryCriteriaManager which should be used for the search.

Returns:

List the found entities.

deleteAllBy

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

Method for deleting entities using a QueryCriteriaManagers.

Parameters:

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

qcm - the QueryCriteriaManager which should be used when deleting.

Returns:

Boolean if the deletion was successful.