Interface IProjektHandler

All Superinterfaces:
IAPIHandler, IGenericHandler, Serializable
All Known Implementing Classes:
ProjektHandler
public interface IProjektHandler extends IGenericHandler
Author:
XIMA MEDIA GmbH

  • Method Details

    • getCurrentFormVersion

      FormVersion getCurrentFormVersion(UserContext uc, Projekt projekt, FrontendServer fs)
      Gets the current form version.
      Parameters:
      uc - the uc
      projekt - the projekt
      fs - the FrontendServer
      Returns:
      the current form version

    • getAccessGroups

      List<BenutzerGruppe> getAccessGroups(UserContext uc, Projekt project)

    • 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

    • isZugriffsbeschraenkt

      Boolean isZugriffsbeschraenkt(UserContext uc, Projekt projekt)

    • isZugriffsberechtigt

      @Deprecated Boolean isZugriffsberechtigt(UserContext uc, Projekt projekt, Benutzer ben)
      Deprecated.

    • importProjekt

      Projekt importProjekt(UserContext uc, Mandant mandant, byte[] bytes, String name, String beschreibung, String title) throws Exception
      Throws:
      Exception

    • 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

    • getAllByClient

      List<Projekt> getAllByClient(UserContext uc, Mandant mandant, boolean includeTemplates)

    • getAllByClient

      List<Projekt> getAllByClient(UserContext uc, Mandant mandant, String scope, boolean includeTemplates)

    • getAllTemplatesByClient

      List<Projekt> getAllTemplatesByClient(UserContext uc, Mandant client)

    • getAllTemplatesByClient

      List<Projekt> getAllTemplatesByClient(UserContext uc, Mandant client, String scope)

    • getAllByEditorUser

      @Deprecated List<Projekt> getAllByEditorUser(UserContext uc, Benutzer editor, Mandant client, String projectScope)
      Deprecated.
      Gets all projects where the given user is editor of
      Parameters:
      uc - UserContext
      editor - Editor user of the projects
      client - Mandant client of the projects
      projectScope - the scope of the projects to load
      Returns:
      List of Projekts
      Since:
      6.0.0

    • copy

      Projekt copy(UserContext uc, Projekt projekt, long id, long formVersionId, long workflowVersionId) throws Exception
      Throws:
      Exception

    • isActivationAllowed

      boolean isActivationAllowed(UserContext uc, Projekt projekt)

    • isFsAllowed

      boolean isFsAllowed(UserContext uc, Projekt project, FrontendServer fs)
      Checks on whether the project can be accessed via the frontend server.
      Parameters:
      uc - the UserContext to use
      project - the project
      fs - the frontendserver
      Returns:
      Boolean of the Projekt is allowed on this FrontendServer
      Since:
      4.3.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

    • getCustomAttributes

      Map<String,String> getCustomAttributes(UserContext uc, Projekt project)

    • getAllByMandant

      @Deprecated List<Projekt> getAllByMandant(UserContext uc, Mandant mandant)
      Deprecated.
      use getAllByClient(UserContext, Mandant, boolean)
      Parameters:
      uc - the UserContext to use
      mandant - the client
      Returns:
      List of Projekts

    • getAllByUserPortal

      @Deprecated PagedResult<Projekt> getAllByUserPortal(UserContext uc, UserPortal portal, int page, int pageSize)
      Deprecated.
      use getProjectsPage(UserContext, PageQuery, ProjectsPageQuery, boolean)
      Returns all projects enabled for the given user portal. Sorted by the name of a project.
      Parameters:
      uc - user context for database transactions.
      portal - to get the projects for.
      page - to get.
      pageSize - size of the page to get.
      Returns:
      all projects enabled for the given user portal.
      Since:
      8.2.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)