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

Interface IProjektHandler

    • Method Detail

      • isEditingAllowed

        @Deprecated
Boolean isEditingAllowed​(UserContext uc,
                         Projekt projekt,
                         Benutzer ben)
        Deprecated.
        Parameters:
        uc - Current user context.
        projekt - Project for which to check if the user may edit it.
        ben - User to check.
        Returns:
        Whether the user groups of the user allow editing the given form (project). Note that there may be other restrictions from the user's role etc that apply.
        Since:
        8.0.0

      • addProjektRessource

        Projekt addProjektRessource​(UserContext uc,
                            long projektId,
                            long ressourceId)

      • getInitializedById

        Projekt getInitializedById​(UserContext uc,
                           Long projectId)
        Reads the project by the given ID and initializes it.
        Parameters:
        uc - UserContext to use for DB transaction
        projectId - ID of the project
        Returns:
        the initialized project

      • getUserPortalProjectFile

        ProjectFile getUserPortalProjectFile​(UserContext uc,
                                     UUID portalUuid,
                                     UUID clientUuid,
                                     UUID projectUuid,
                                     UUID fileUuid)
        Returns the project file with the given file UUID in the context of the user portal with the given UUID.
        Parameters:
        uc - User context for accessing the database.
        portalUuid - UUID of the user portal (context).
        clientUuid - UUID of the client (context).
        projectUuid - UUID of the project.
        fileUuid - UUID of the project file.
        Returns:
        The project file with the given UUID, or null if no such project file exists.
        Throws:
        de.xima.cmn.http.exception.NotFoundException - if no portal with the given UUID exists, if no client with the given UUID exists, or if no project with the given UUID exists.
        Since:
        8.4.0

      • getByUUID

        Projekt getByUUID​(UserContext uc,
                  Mandant client,
                  String uuid)
        Gets a project by its UUID. The project must owned by the given client.
        Parameters:
        uc - User context of the user who wishes to get the project.
        client - The client who owns the project.
        uuid - UUID of the project.
        Returns:
        The project or null if it does not exist.

      • getByUUID

        Projekt getByUUID​(UserContext uc,
                  Mandant client,
                  UUID uuid)
        Gets a project by its UUID. The project must owned by the given client.
        Parameters:
        uc - User context of the user who wishes to get the project.
        client - The client who owns the project.
        uuid - UUID of the project.
        Returns:
        The project or null if it does not exist.

      • getByUUID

        Projekt getByUUID​(UserContext uc,
                  UUID clientUuid,
                  UUID uuid)
        Gets a project by its UUID. The project must owned by the given client.
        Parameters:
        uc - User context of the user who wishes to get the project.
        clientUuid - UUID of the client.
        uuid - UUID of the project.
        Returns:
        The project or null if it does not exist.
        Since:
        8.3.0

      • getProjectsPage

        PagedResult<Projekt> getProjectsPage​(UserContext uc,
                                     PageQuery page,
                                     ProjectsPageQuery filter,
                                     boolean skipCount)
        Returns all projects enabled for the given user portal. Sorted by their display name.
        Parameters:
        uc - user context for database transactions.
        page - page request defining the page and page size.
        filter - project page request defining the user portal, filters.
        skipCount - The number of rows to skip.
        Returns:
        all projects enabled for the given user portal.
        Since:
        8.4.0

      • getProjectsCount

        int getProjectsCount​(UserContext uc,
                     ProjectsPageQuery filter)
        Returns the number of projects for the given page request and filter.
        Parameters:
        uc - user context for database transactions.
        filter - page request defining the user portal, filters.
        Returns:
        the number of projects enabled for the given user portal.
        Since:
        8.4.0

      • getActiveByUserPortalAndFrontendServer

        Projekt getActiveByUserPortalAndFrontendServer​(UserContext uc,
                                               UUID userPortalUuid,
                                               UUID formUuid,
                                               Long frontendServerId)

      • getActiveByUUIDAndFrontendServer

        Projekt getActiveByUUIDAndFrontendServer​(UserContext uc,
                                         UUID clientUuid,
                                         UUID formUuid,
                                         Long frontendServerId)