Package de.xima.fc.dao.interfaces

Interface IVorgangDao

    • Method Detail

      • getByUuidAndUser

        Vorgang getByUuidAndUser​(IEntityContext ec,
                         UUID uuid,
                         IUser user)
        Finds the form record for the given UUID if the given user has submitted it at some point.
        Parameters:
        ec - entity context for accessing the database.
        uuid - the UUID of the form record
        user - to get the form record for.
        Returns:
        The form record with the given UUID if it exists and the user has submitted it at one point. null otherwise.
        Since:
        8.2.0

      • getByUser

        List<Vorgang> getByUser​(IEntityContext ec,
                        IUser user)
        Gets a list of all form records the user has submitted at some point, in descending order of their (last) modification instant.
        Parameters:
        ec - entity context for database transactions.
        user - that has submitted the form records at some point.
        Returns:
        a list of all form records the user has submitted at some point, in descending order of their (last) modification instant.
        Since:
        8.2.0

      • getByUser

        PagedResult<Vorgang> getByUser​(IEntityContext ec,
                               IUser user,
                               int page,
                               int pageSize)
        Gets a sub list of form records the user has submitted at some point, in descending order of their (last) modification instant.
        Parameters:
        ec - entity context for database transactions.
        user - that has submitted the form records at some point.
        page - to get.
        pageSize - size of the page to get. Defines the size of the returned sub list.
        Returns:
        a sub list of form records the user has submitted at some point, in descending order of their (last) modification instant.
        Since:
        8.2.0

      • bulkDeleteAll

        int bulkDeleteAll​(IEntityContext ec,
                  Projekt project)
        Parameters:
        ec - IEntityContext for accessing the database.
        project - Projekt to which the form record belongs.
        Returns:
        count of deleted entries
        Since:
        6.0.2

      • existsIdentityToken

        boolean existsIdentityToken​(IEntityContext ec,
                            Vorgang formRecord,
                            String identityToken,
                            Projekt project)
        Checks whether there exists any form record that
        • belongs to the same project as the given project
        • is not the same as the given form record
        • but has got the same identity token as the given token
        Parameters:
        ec - Entity context for accessing the database.
        formRecord - Current form record. If null, allows all form records for the given project.
        identityToken - New identity token to be checked.
        project - Project to which the form record belongs.
        Returns:
        True iff a form record with the given identity token exists already.

      • deleteAllUnverified

        int deleteAllUnverified​(IEntityContext ec)
        Parameters:
        ec - Entity context for accessing the database.

      • bulkMarkRead

        int bulkMarkRead​(IEntityContext ec,
                 List<Long> formRecordIds,
                 boolean read)
        Bulk updates the 'read' value of all form records with the given IDs to the given 'read' value iff the authenticated user given by the entity context has permission to access the form records. If the entity context does not provide an authenticated user (e.g. a virtual user) no form records will be updated.
        Parameters:
        ec - IEntityContext with an authenticated user for database transactions. For creating an entity context for an authenticated user see EntityContextFactory.newEntityContext(IUser).
        formRecordIds - List of IDs of the form records that the user requests to be updated.
        read - Boolean value to set the attribute 'gelesen' to
        Returns:
        the number of updated records.
        Throws:
        de.xima.cmn.dao.exceptions.UpdateException - if the given entity context does not provide an authenticated user.
        Since:
        6.2.1

      • bulkMove

        int bulkMove​(IEntityContext ec,
             Set<Long> formRecordIds,
             Postfach inbox)
        Bulk moves all form records with the given IDs to the given inbox iff the authenticated user given by the entity context has permission to access the form records. If the entity context does not provide an authenticated user (e.g. a virtual user) no form records will be updated.
        Parameters:
        ec - IEntityContext with an authenticated user for database transactions. For creating an entity context for an authenticated user see EntityContextFactory.newEntityContext(IUser).
        formRecordIds - Set of IDs of the form records that the user requests to be updated.
        Returns:
        the number of updated records.
        Throws:
        de.xima.cmn.dao.exceptions.UpdateException - if the given entity context does not provide an authenticated user.
        Since:
        8.0.2

      • bulkDelete

        int bulkDelete​(IEntityContext ec,
               List<Long> formRecordIds)
        throws de.xima.cmn.dao.exceptions.DeleteException
        Bulk deletes all form records with the given IDs iff the authenticated user given by the entity context has permission to access the form records and the form records can be deleted (the state allows deletion). If the entity context does not provide an authenticated user (e.g. a virtual user) no form records will be deleted.
        Parameters:
        ec - IEntityContext with an authenticated user for database transactions. For creating an entity context for an authenticated user see EntityContextFactory.newEntityContext(IUser).
        formRecordIds - List of IDs of the form records that the user requests to be deleted.
        Returns:
        the number of deleted form records.
        Throws:
        de.xima.cmn.dao.exceptions.DeleteException - if the given entity context does not provide an authenticated user.
        Since:
        8.0.2

      • getByUUID

        Vorgang getByUUID​(IEntityContext ec,
                  String uuid)
        Returns the form record with the given UUID
        Parameters:
        ec - IEntityContext to use
        uuid - String UUID of the template
        Returns:
        The appointment template for the given UUID

      • getByUUID

        Vorgang getByUUID​(IEntityContext ec,
                  UUID uuid)
        Returns the form record with the given UUID
        Parameters:
        ec - IEntityContext to use
        uuid - UUID UUID of the template
        Returns:
        The appointment template for the given UUID

      • getParent

        @Nullable
Vorgang getParent​(IEntityContext ec,
                  Vorgang formRecord)
        Parameters:
        ec - Entity context to access the database.
        formRecord - Form record for which to find the parent.
        Returns:
        The parent form record of the given form record, or null if no parent exists.

      • getChildren

        List<Vorgang> getChildren​(IEntityContext ec,
                          Vorgang formRecord)
        Parameters:
        ec - Entity context to access the database.
        formRecord - Form record for which to find the parent.
        Returns:
        All children of the given form record, or an empty list if no children exist.

      • getCountByAuthenticatorDependentCreator

        int getCountByAuthenticatorDependentCreator​(IEntityContext ec,
                                            IAuthenticator<?> authenticator)
        Returns the number of form records that have a creator that is dependent on this authenticator.
        Parameters:
        ec - Entity context to access the database.
        authenticator - the creator of a form record used.
        Returns:
        the number of form records that have a creator that is dependent on this authenticator.
        Since:
        8.0.0

      • addSubmission

        Vorgang addSubmission​(IEntityContext ec,
                      Vorgang formRecord,
                      IUser user,
                      EFormRecordSubmitContext submitContext,
                      FrontendServer submitFrontendServer,
                      String submitServerBaseUrl,
                      String formData,
                      boolean newDataEntry)
        Adds a new submission to the form record.
        Parameters:
        ec - Entity context for accessing the database.
        formRecord - The form record to which the submission should be added.
        user - user who submitted the form record.
        submitContext - The context in which the form record was submitted.
        submitFrontendServer - The frontend server that received the submission.
        submitServerBaseUrl - The base URL of the server that received the submission.
        formData - The data of the submission.
        newDataEntry - Whether the submission data should be stored as a new data entry.
        Returns:
        The updated form record with the added submission.
        Since:
        8.2.0