de.xima.fc.handler.interfaces.entity

Interface IGenericHandler

All Superinterfaces:

IAPIHandler, Serializable

All Known Subinterfaces:

IAktionHandler, IAppointmentHandler, IAppointmentSlotHandler, IAppointmentTemplateHandler, IAppointmentTypeHandler, IAttachmentHandler, IBenutzerGruppeHandler, IBenutzerHandler, IDatenbankzugriffHandler, IDatenquelleHandler, IEntityberechtigungHandler, IFileHandler, IFormEingangHandler, IFormVersionHandler, IFrontendServerHandler, ILDAPAbfrageHandler, ILDAPGruppeHandler, ILDAPZugriffHandler, IMandantFrontendServerHandler, IMandantHandler, IMandantLdapDataHandler, IMandantMailDataHandler, IMandantRessourcenHandler, IModulHandler, IPostfachHandler, IProjectDOIDataHandler, IProjektHandler, IProjektRessourcenHandler, IProjektZaehlerDatenHandler, IProjektZaehlerHandler, IRolleHandler, ISystemPropertyHandler, ITextbausteinHandler, IVorgangHandler, IWorkflowHandler

All Known Implementing Classes:

AktionHandler, AppointmentHandler, AppointmentSlotHandler, AppointmentTemplateHandler, AppointmentTypeHandler, AttachmentHandler, BenutzerGruppeHandler, BenutzerHandler, DatenbankzugriffHandler, DatenquelleHandler, EntityberechtigungHandler, FileHandler, FormEingangHandler, FormElementHandler, FormVersionHandler, FrontendServerHandler, GenericHandler, LDAPAbfrageHandler, LDAPGruppeHandler, LDAPZugriffHandler, MandantFrontendServerHandler, MandantHandler, MandantLdapDataHandler, MandantMailDataHandler, MandantRessourceHandler, ModulHandler, PostfachHandler, ProjectDOIDataHandler, ProjektHandler, ProjektRessourceHandler, ProjektZaehlerDatenHandler, ProjektZaehlerHandler, RolleHandler, SystemPropertyHandler, TextbausteinHandler, VorgangHandler, WorkflowHandler

public interface IGenericHandler
extends IAPIHandler

The Class GenericHandler.

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method and Description
<T extends ITransferableEntity> T[]	create(Class<T> entityClass, UserContext uc, T... entities) Creates the.
<T extends ITransferableEntity> T	create(Class<T> entityClass, UserContext uc, T entity) Creates the.
<T extends ITransferableEntity> Boolean	delete(Class<T> entityClass, UserContext uc, T... entities) Delete.
<T extends ITransferableEntity> Boolean	delete(Class<T> entityClass, UserContext uc, T entities) Delete.
<T extends ITransferableEntity,C extends de.xima.cmn.criteria.interfaces.IFilterableCriteriaManager & de.xima.cmn.criteria.interfaces.ISortableCriteriaManager & de.xima.cmn.criteria.interfaces.IPageableCriteriaManager & de.xima.cmn.criteria.interfaces.IQueryHintProviding> Boolean	deleteBy(Class<T> entityClass, UserContext uc, C cm) Delete by.
<T extends ITransferableEntity> Boolean	deleteById(Class<T> entityClass, UserContext uc, Integer id)
<T extends ITransferableEntity> Boolean	deleteById(Class<T> entityClass, UserContext uc, Long id) Delete by id.
<T extends ITransferableEntity> List<T>	getAll(Class<T> entityClass, UserContext uc) Gets the all.
<T extends ITransferableEntity,C extends de.xima.cmn.criteria.interfaces.IFilterableCriteriaManager & de.xima.cmn.criteria.interfaces.ISortableCriteriaManager & de.xima.cmn.criteria.interfaces.IPageableCriteriaManager & de.xima.cmn.criteria.interfaces.IQueryHintProviding> List<T>	getAllBy(Class<T> entityClass, UserContext uc, C cm) Gets the all by.
<T extends ITransferableEntity,C extends de.xima.cmn.criteria.interfaces.IFilterableCriteriaManager & de.xima.cmn.criteria.interfaces.ISortableCriteriaManager & de.xima.cmn.criteria.interfaces.IPageableCriteriaManager & de.xima.cmn.criteria.interfaces.IQueryHintProviding & de.xima.cmn.criteria.interfaces.ISelectableCriteriaManager> List<Map<String,Serializable>>	getAttributes(Class<T> entityClass, UserContext uc, C cm) Gets a list of attributes specified in the given criteria manager C
<R,T extends ITransferableEntity,C extends de.xima.cmn.criteria.interfaces.IFilterableCriteriaManager & de.xima.cmn.criteria.interfaces.ISortableCriteriaManager & de.xima.cmn.criteria.interfaces.IPageableCriteriaManager & de.xima.cmn.criteria.interfaces.IQueryHintProviding & de.xima.cmn.criteria.interfaces.ISelectableCriteriaManager> List<R>	getAttributes(Class<T> entityClass, UserContext uc, C cm, Class<R> resultClass) Gets a list of attributes specified in the given criteria manager C. the attribute values will be returned as objects defined by the result class
<T extends ITransferableEntity,C extends de.xima.cmn.criteria.interfaces.IFilterableCriteriaManager & de.xima.cmn.criteria.interfaces.ISortableCriteriaManager & de.xima.cmn.criteria.interfaces.IPageableCriteriaManager & de.xima.cmn.criteria.interfaces.IQueryHintProviding> T	getBy(Class<T> entityClass, UserContext uc, C cm) Gets the by.
<T extends ITransferableEntity> T	getById(Class<T> entityClass, UserContext uc, Integer id)
<T extends ITransferableEntity> T	getById(Class<T> entityClass, UserContext uc, Long id) Gets the by id.
<T extends ITransferableEntity> T	getById(String entityClass, UserContext uc, String id) Gets the by id.
<T extends ITransferableEntity,C extends de.xima.cmn.criteria.interfaces.IFilterableCriteriaManager & de.xima.cmn.criteria.interfaces.IQueryHintProviding> Integer	resultTotalCount(Class<T> entityClass, UserContext uc, C cm) Result total count.
<T extends ITransferableEntity> T[]	update(Class<T> entityClass, UserContext uc, T... entities) Update.
<T extends ITransferableEntity> T	update(Class<T> entityClass, UserContext uc, T entity) Update.

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

getName

Method Detail

getAll

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

Gets the all.

Type Parameters:

T - the generic type

Parameters:

entityClass - the entity class

uc - the uc

Returns:

the all @

getAllBy

<T extends ITransferableEntity,C extends de.xima.cmn.criteria.interfaces.IFilterableCriteriaManager & de.xima.cmn.criteria.interfaces.ISortableCriteriaManager & de.xima.cmn.criteria.interfaces.IPageableCriteriaManager & de.xima.cmn.criteria.interfaces.IQueryHintProviding> List<T> getAllBy(Class<T> entityClass,
                                                                                                                                                                                                                                                                                                  UserContext uc,
                                                                                                                                                                                                                                                                                                  C cm)

Gets the all by.

Type Parameters:

T - the generic type

Parameters:

entityClass - the entity class

uc - the uc

cm - the qcm

Returns:

the all by @

getBy

<T extends ITransferableEntity,C extends de.xima.cmn.criteria.interfaces.IFilterableCriteriaManager & de.xima.cmn.criteria.interfaces.ISortableCriteriaManager & de.xima.cmn.criteria.interfaces.IPageableCriteriaManager & de.xima.cmn.criteria.interfaces.IQueryHintProviding> T getBy(Class<T> entityClass,
                                                                                                                                                                                                                                                                                         UserContext uc,
                                                                                                                                                                                                                                                                                         C cm)

Gets the by.

Type Parameters:

T - the generic type

Parameters:

entityClass - the entity class

uc - the uc

cm - the qcm

Returns:

the by @

getById

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

Gets the by id.

Type Parameters:

T - the generic type

Parameters:

entityClass - the entity class

uc - the uc

id - the id

Returns:

the by id @

getById

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

getById

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

Gets the by id.

Type Parameters:

T - the generic type

Parameters:

entityClass - the entity class

uc - the uc

id - the id

Returns:

the by id @

getAttributes

<T extends ITransferableEntity,C extends de.xima.cmn.criteria.interfaces.IFilterableCriteriaManager & de.xima.cmn.criteria.interfaces.ISortableCriteriaManager & de.xima.cmn.criteria.interfaces.IPageableCriteriaManager & de.xima.cmn.criteria.interfaces.IQueryHintProviding & de.xima.cmn.criteria.interfaces.ISelectableCriteriaManager> List<Map<String,Serializable>> getAttributes(Class<T> entityClass,
                                                                                                                                                                                                                                                                                                                                                                                           UserContext uc,
                                                                                                                                                                                                                                                                                                                                                                                           C cm)
                                                                                                                                                                                                                                                                                                                                                                                    throws NotSerializableException

Gets a list of attributes specified in the given criteria manager C

Type Parameters:

T - type of the entity

C - type of the criteria manager

Parameters:

entityClass - Class of the entity

uc - UserContext that will be used

cm - C criteria manager specifying the filtering, sorting, paging and selection of attributes

Returns:

List of Tuples containing the attribute values

Throws:

NotSerializableException

getAttributes

<R,T extends ITransferableEntity,C extends de.xima.cmn.criteria.interfaces.IFilterableCriteriaManager & de.xima.cmn.criteria.interfaces.ISortableCriteriaManager & de.xima.cmn.criteria.interfaces.IPageableCriteriaManager & de.xima.cmn.criteria.interfaces.IQueryHintProviding & de.xima.cmn.criteria.interfaces.ISelectableCriteriaManager> List<R> getAttributes(Class<T> entityClass,
                                                                                                                                                                                                                                                                                                                                                                      UserContext uc,
                                                                                                                                                                                                                                                                                                                                                                      C cm,
                                                                                                                                                                                                                                                                                                                                                                      Class<R> resultClass)

Gets a list of attributes specified in the given criteria manager C. the attribute values will be returned as objects defined by the result class

Type Parameters:

R - type of result object

T - type of the entity

C - type of the criteria manager

Parameters:

entityClass - Class of the entity

uc - UserContext that will be used

cm - C criteria manager specifying the filtering, sorting, paging and selection of attributes

resultClass - Class of the result objects

Returns:

List of Rs containing the attribute values

create

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

Creates the.

Type Parameters:

T - the generic type

Parameters:

entityClass - the entity class

uc - the uc

entities - the entities

Returns:

the t[] @

create

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

Creates the.

Type Parameters:

T - the generic type

Parameters:

entityClass - the entity class

uc - the uc

entity - the entity

Returns:

the t @

update

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

Update.

Type Parameters:

T - the generic type

Parameters:

entityClass - the entity class

uc - the uc

entities - the entities

Returns:

the t[] @

update

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

Update.

Type Parameters:

T - the generic type

Parameters:

entityClass - the entity class

uc - the uc

entity - the entity

Returns:

the t @

delete

<T extends ITransferableEntity> Boolean delete(Class<T> entityClass,
                                               UserContext uc,
                                               T... entities)

Delete.

Type Parameters:

T - the generic type

Parameters:

entityClass - the entity class

uc - the uc

entities - the entities

Returns:

the boolean @

delete

<T extends ITransferableEntity> Boolean delete(Class<T> entityClass,
                                               UserContext uc,
                                               T entities)

Delete.

Type Parameters:

T - the generic type

Parameters:

entityClass - the entity class

uc - the uc

entities - the entities

Returns:

the boolean @

deleteBy

<T extends ITransferableEntity,C extends de.xima.cmn.criteria.interfaces.IFilterableCriteriaManager & de.xima.cmn.criteria.interfaces.ISortableCriteriaManager & de.xima.cmn.criteria.interfaces.IPageableCriteriaManager & de.xima.cmn.criteria.interfaces.IQueryHintProviding> Boolean deleteBy(Class<T> entityClass,
                                                                                                                                                                                                                                                                                                  UserContext uc,
                                                                                                                                                                                                                                                                                                  C cm)

Delete by.

Type Parameters:

T - the generic type

Parameters:

entityClass - the entity class

uc - the uc

cm - the qcm

Returns:

the boolean @

deleteById

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

Delete by id.

Type Parameters:

T - the generic type

Parameters:

entityClass - the entity class

uc - the uc

id - the id

Returns:

the boolean @

deleteById

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

resultTotalCount

<T extends ITransferableEntity,C extends de.xima.cmn.criteria.interfaces.IFilterableCriteriaManager & de.xima.cmn.criteria.interfaces.IQueryHintProviding> Integer resultTotalCount(Class<T> entityClass,
                                                                                                                                                                                    UserContext uc,
                                                                                                                                                                                    C cm)

Result total count.

Type Parameters:

T - the generic type

Parameters:

entityClass - the entity class

uc - the uc

cm - the qcm

Returns:

the integer @