Package de.xima.fc.handler.interfaces.entity

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, IFormVersionHandler, IFrontendServerHandler, IIndirectClientAuthorizationHandler, ILDAPAbfrageHandler, ILDAPGruppeHandler, ILDAPZugriffHandler, ILicenseFileHandler, ILicenseHandler, IMandantFrontendServerHandler, IMandantHandler, IMandantLdapDataHandler, IMandantMailDataHandler, IMandantRessourcenHandler, IModulHandler, IPostfachHandler, IProjectDOIDataHandler, IProjectIdentityCheckDataHandler, IProjektHandler, IProjektRessourcenHandler, IProjektZaehlerDatenHandler, IProjektZaehlerHandler, IRolleHandler, ISystemAuthenticatorHandler, ISystemPropertyHandler, ITextbausteinHandler, IUserCredentialsHandler, IUserEmailHandler, IUserIdentityHandler, IUserProfileHandler, IUserProfileMfaHandler, 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, FormVersionHandler, FrontendServerHandler, GenericHandler, IndirectClientAuthorizationHandler, LDAPAbfrageHandler, LDAPGruppeHandler, LDAPZugriffHandler, LicenseFileHandler, LicenseHandler, MandantFrontendServerHandler, MandantHandler, MandantLdapDataHandler, MandantMailDataHandler, MandantRessourceHandler, ModulHandler, PostfachHandler, ProjectDOIDataHandler, ProjectIdentityCheckDataHandler, ProjektHandler, ProjektRessourceHandler, ProjektZaehlerDatenHandler, ProjektZaehlerHandler, RolleHandler, SystemAuthenticatorHandler, SystemPropertyHandler, TextbausteinHandler, UserCredentialsHandler, UserEmailHandler, UserIdentityHandler, UserProfileHandler, UserProfileMfaHandler, VorgangHandler, WebDavAccessHandler, WorkflowHandler, WorkflowNodeHandler, WorkflowStateHandler, WorkflowTaskHandler, WorkflowTriggerHandler, WorkflowVersionHandler
public interface IGenericHandler extends IAPIHandler
The Class GenericHandler.
Author:
XIMA MEDIA GmbH

  • Method Details

    • 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 - The class of the entity
      uc - A UserContext that will be used
      cm - A criteria manager specifying the filtering, sorting, paging and selection of attributes
      Returns:
      List of Tuples 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 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 - A criteria manager specifying the filtering, sorting, paging and selection of attributes
      resultClass - 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.
      use de.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 entity
      C - type of the criteria manager
      Parameters:
      entityClass - Class the class of the searched entity
      uc - UserContext which will be used
      cm - 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 be null. The lists contained in the criteria manager can also be null 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 placed
      T - type of entity
      C - type of the criteria manager
      Parameters:
      entityClass - Class the class of the searched entity
      uc - UserContext which will be used
      cm - 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 be null. The lists contained in the criteria manager can also be null 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 type R.
      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 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 @