Interface IGenericHandler
-
- All Superinterfaces:
IAPIHandler
,Serializable
- All Known Subinterfaces:
IAktionHandler
,IAppointmentHandler
,IAppointmentSlotHandler
,IAppointmentTemplateHandler
,IAppointmentTypeHandler
,IAttachmentHandler
,IBenutzerGruppeHandler
,IBenutzerHandler
,IClientAuthenticatorHandler
,IClientCounterHandler
,IDatenbankzugriffHandler
,IDatenquelleHandler
,IDirectClientAuthorizationHandler
,IEntityberechtigungHandler
,IFileHandler
,IFormEingangHandler
,IFormRecordChatHandler
,IFormRecordMessageHandler
,IFormRecordSubmissionHandler
,IFormVersionHandler
,IFrontendServerHandler
,IIndirectClientAuthorizationHandler
,ILDAPAbfrageHandler
,ILDAPGruppeHandler
,ILDAPZugriffHandler
,ILicenseFileHandler
,ILicenseHandler
,IMandantFrontendServerHandler
,IMandantHandler
,IMandantLdapDataHandler
,IMandantMailDataHandler
,IMandantRessourcenHandler
,IModulHandler
,IPostfachHandler
,IProjectDOIDataHandler
,IProjectIdentityCheckDataHandler
,IProjectPortalDataHandler
,IProjektHandler
,IProjektRessourcenHandler
,IProjektZaehlerDatenHandler
,IProjektZaehlerHandler
,IRolleHandler
,ISystemAuthenticatorHandler
,ISystemPropertyHandler
,ITextbausteinHandler
,IUserCredentialsHandler
,IUserEmailHandler
,IUserIdentityHandler
,IUserPortalAuthConfigHandler
,IUserPortalHandler
,IUserProfileHandler
,IUserProfileMfaHandler
,IUserTokenHandler
,IVorgangHandler
,IWebDavAccessHandler
,IWorkflowHandler
,IWorkflowNodeHandler
,IWorkflowStateHandler
,IWorkflowTaskHandler
,IWorkflowTriggerHandler
,IWorkflowVersionHandler
- All Known Implementing Classes:
AktionHandler
,AppointmentHandler
,AppointmentSlotHandler
,AppointmentTemplateHandler
,AppointmentTypeHandler
,AttachmentHandler
,BenutzerGruppeHandler
,BenutzerHandler
,ClientAuthenticatorHandler
,ClientCounterHandler
,DatenbankzugriffHandler
,DatenquelleHandler
,DirectClientAuthorizationHandler
,EntityberechtigungHandler
,FileHandler
,FormEingangHandler
,FormElementHandler
,FormRecordChatHandler
,FormRecordMessageHandler
,FormRecordSubmissionHandler
,FormVersionHandler
,FrontendServerHandler
,GenericHandler
,IndirectClientAuthorizationHandler
,LDAPAbfrageHandler
,LDAPGruppeHandler
,LDAPZugriffHandler
,LicenseFileHandler
,LicenseHandler
,MandantFrontendServerHandler
,MandantHandler
,MandantLdapDataHandler
,MandantMailDataHandler
,MandantRessourceHandler
,ModulHandler
,PostfachHandler
,ProjectDOIDataHandler
,ProjectIdentityCheckDataHandler
,ProjectPortalDataHandler
,ProjektHandler
,ProjektRessourceHandler
,ProjektZaehlerDatenHandler
,ProjektZaehlerHandler
,RolleHandler
,SystemAuthenticatorHandler
,SystemPropertyHandler
,TextbausteinHandler
,UserCredentialsHandler
,UserEmailHandler
,UserIdentityHandler
,UserPortalAuthConfigHandler
,UserPortalHandler
,UserProfileHandler
,UserProfileMfaHandler
,UserTokenHandler
,VorgangHandler
,WebDavAccessHandler
,WorkflowHandler
,WorkflowNodeHandler
,WorkflowStateHandler
,WorkflowTaskHandler
,WorkflowTriggerHandler
,WorkflowVersionHandler
public interface IGenericHandler extends IAPIHandler
The Class GenericHandler.- Author:
- XIMA MEDIA GmbH
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description <T extends ITransferableEntity>
Tcreate(Class<T> entityClass, UserContext uc, T entity)
Creates the.<T extends ITransferableEntity>
T[]create(Class<T> entityClass, UserContext uc, T... entities)
Creates the.<T extends ITransferableEntity>
Booleandelete(Class<T> entityClass, UserContext uc, T entities)
Delete.<T extends ITransferableEntity>
Booleandelete(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>
BooleandeleteBy(Class<T> entityClass, UserContext uc, C cm)
Delete by.<T extends ITransferableEntity>
BooleandeleteById(Class<T> entityClass, UserContext uc, Integer id)
<T extends ITransferableEntity>
BooleandeleteById(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 managerC
<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.<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>
TgetBy(Class<T> entityClass, UserContext uc, C cm)
Gets the by.<T extends ITransferableEntity>
TgetById(Class<T> entityClass, UserContext uc, Integer id)
<T extends ITransferableEntity>
TgetById(Class<T> entityClass, UserContext uc, Long id)
Gets the by id.<T extends ITransferableEntity>
TgetById(String entityClass, UserContext uc, String id)
Gets the by id.<R,T extends ITransferableEntity>
Set<R>getEntityRefs(Class<T> entityClass, UserContext uc, T entity)
Returns a set of entities that reference the given entity and depend on it.<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>
javax.persistence.TuplegetSingleAttributes(Class<T> entityClass, UserContext uc, C cm)
Deprecated.usede.xima.fc.handler.interfaces.entity.IGenericHandler.getSingleAttributes(Class, UserContext, IFilterableCriteriaManager, Class)
<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>
RgetSingleAttributes(Class<T> entityClass, UserContext uc, C cm, Class<R> resultClass)
This method allows for the selection of certain attributes of an entity instead of reading the entire entity<T extends ITransferableEntity,C extends de.xima.cmn.criteria.interfaces.IFilterableCriteriaManager & de.xima.cmn.criteria.interfaces.IQueryHintProviding>
IntegerresultTotalCount(Class<T> entityClass, UserContext uc, C cm)
Result total count.<T extends ITransferableEntity>
Tupdate(Class<T> entityClass, UserContext uc, T entity)
Update.<T extends ITransferableEntity>
T[]update(Class<T> entityClass, UserContext uc, T... entities)
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 classuc
- 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 classuc
- the uccm
- 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 classuc
- the uccm
- 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 classuc
- the ucid
- 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 classuc
- the ucid
- 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 managerC
- Type Parameters:
T
- type of the entityC
- type of the criteria manager- Parameters:
entityClass
- The class of the entityuc
- AUserContext
that will be usedcm
- A criteria manager specifying the filtering, sorting, paging and selection of attributes- Returns:
List
ofTuple
s containing the attribute values- Throws:
NotSerializableException
- When any of the requested entity fields are not serializable.
-
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. the attribute values will be returned as objects defined by the result class- Type Parameters:
R
- type of result objectT
- type of the entityC
- type of the criteria manager- Parameters:
entityClass
-Class
of the entityuc
-UserContext
that will be usedcm
- A criteria manager specifying the filtering, sorting, paging and selection of attributesresultClass
-Class
of the result objects- Returns:
- A list of results containing the attribute values
-
getSingleAttributes
@Deprecated <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> javax.persistence.Tuple getSingleAttributes(Class<T> entityClass, UserContext uc, C cm)
Deprecated.usede.xima.fc.handler.interfaces.entity.IGenericHandler.getSingleAttributes(Class, UserContext, IFilterableCriteriaManager, Class)
This method allows for the selection of certain attributes of an entity instead of reading the entire entity- Type Parameters:
T
- type of entityC
- type of the criteria manager- Parameters:
entityClass
-Class
the class of the searched entityuc
-UserContext
which will be usedcm
- A criteria manager object, that contains lists for filtering, sorting and selecting. These lists, if available, are included in the SQL query. This value can benull
. The lists contained in the criteria manager can also benull
or empty.- Returns:
Tuple
that contains the values of the selected attributes- Since:
- 6.6.0
-
getSingleAttributes
<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> R getSingleAttributes(Class<T> entityClass, UserContext uc, C cm, Class<R> resultClass)
This method allows for the selection of certain attributes of an entity instead of reading the entire entity- Type Parameters:
R
- type of object, in which the result values will be placedT
- type of entityC
- type of the criteria manager- Parameters:
entityClass
-Class
the class of the searched entityuc
-UserContext
which will be usedcm
- A criteria manager object, that contains lists for filtering, sorting and selecting. These lists, if available, are included in the SQL query. This value can benull
. The lists contained in the criteria manager can also benull
or empty.resultClass
-Class
of the object, in which the result value will be placed- Returns:
- A result that contains the values of the selected attributes
- Since:
- 6.6.0
-
getEntityRefs
<R,T extends ITransferableEntity> Set<R> getEntityRefs(Class<T> entityClass, UserContext uc, T entity)
Returns a set of entities that reference the given entity and depend on it. An entity can usually not be deleted if it is still being referenced by and depended on by other entities.- Type Parameters:
R
- type of the entities that are referencing the given entity.T
- type of the entity that is being referenced.- Parameters:
entityClass
- the class of the entity that is being referenced.uc
- user context for database transactions.entity
- being referenced.- Returns:
- a set of entities that reference the given entity.
- Throws:
ClassCastException
- if a referencing entity is not of typeR
.- Since:
- 8.0.0
-
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 classuc
- the ucentities
- 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 classuc
- the ucentity
- 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 classuc
- the ucentities
- 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 classuc
- the ucentity
- 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 classuc
- the ucentities
- 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 classuc
- the ucentities
- 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 classuc
- the uccm
- 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 classuc
- the ucid
- 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 classuc
- the uccm
- the qcm- Returns:
- the integer @
-
-