Package de.espirit.firstspirit.agency

Interface ProjectAgent

public interface ProjectAgent
Definition of an agent offering access to project specific information. To retrieve information about remote projects, a SpecialistsBroker operating on the respective remote project can be requested via the BrokerAgent.
Example:
SpecialistsBroker.requireSpecialist(ProjectAgent.TYPE)
Since:
4.2.405
See Also:

  • Field Details

  • Method Details

    • isRemote

      boolean isRemote()
      Indicates that the project is remote.
      Returns:
      true, if remote.
      Since:
      4.2.405

    • getName

      String getName()
      The full name of the project.
      Returns:
      The project's name.
      Since:
      4.2.405

    • getId

      long getId()
      The id of the project.
      Returns:
      the id of the project
      Since:
      4.2.427

    • getSymbolicName

      @Nullable @Nullable String getSymbolicName()
      The symbolic name of the remote configuration this project is registered for.
      Returns:
      The project's symbolic remote name.
      Since:
      4.2.405

    • getRemoteProjectConfigurations

      @NotNull @NotNull Map<String,RemoteProjectConfiguration> getRemoteProjectConfigurations(@Nullable @Nullable Filter<RemoteProjectConfiguration> remoteCondition)
      Get the configurations of remote projects defined.
      Parameters:
      remoteCondition - The condition to be fulfilled for accepting a remote project or null for unconditioned acceptance.
      Returns:
      A map of remote project configurations with their symbolic names as key.
      Since:
      4.2.405

    • getExportedRemoteSchemas

      @NotNull @NotNull Map<Schema,Collection<Long>> getExportedRemoteSchemas()
      When a Schema of a source project is imported into a target project, this method returns a map from the exported schema to all projects it has been imported to when called on the source project.
      Returns:
      A map from each exported schema to the ids of target projects it has been imported to.
      Since:
      5.2.250702

    • getImportedRemoteSchemas

      @NotNull @NotNull Map<Schema,Long> getImportedRemoteSchemas()
      When a Schema of a source project is imported into a target project, this method returns a map from the imported schema to the source project when called on the target project.
      Returns:
      A map from the imported schema to the id of the source project it has been imported from.
      Since:
      5.2.250702

    • getTemplateSets

      @NotNull @NotNull List<TemplateSet> getTemplateSets()
      Get a list of available template sets.
      Returns:
      A list of template sets.
      Since:
      4.2.405

    • hasMetaDataTemplate

      boolean hasMetaDataTemplate()
      Indicates, whether a meta data template is defined in this project.
      Returns:
      true, iff a meta data template is defined.
      Since:
      5.0.100

    • getMetaDataTemplate

      @NotNull @NotNull Template getMetaDataTemplate() throws NoSuchElementException
      Provides the meta data template.
      Returns:
      The meta data template or null, if no template is defined.
      Throws:
      NoSuchElementException - If no template is defined or the template was not found.
      Since:
      5.0.100

    • useRelease

      boolean useRelease()
      Returns true if this project uses the release state, false if it is an auto release project.
      This method does not provide information about whether the used release mode is language-dependent or independent.
      Returns:
      false if it is an auto release project, true otherwise
      Since:
      4.2.405
      See Also:

    • getReleaseMode

      @NotNull @NotNull ReleaseMode getReleaseMode()
      Returns the configured release mode of the project.
      Since:
      5.2.250905

    • isAdmin

      boolean isAdmin(User user)
      Indicates, whether the given user is an administrator of the project.
      Parameters:
      user - A user.
      Returns:
      true, if the user is a project administrator.
      Since:
      5.1.9
      See Also:

    • forbidsPolyglotDataHierarchy

      boolean forbidsPolyglotDataHierarchy()
      Indicates, whether it is forbidden to use language dependent forms on arbitrary levels in a data hierarchy.
      Returns:
      true, if forbidden.
      Since:
      5.2.510

    • useMappingBasedSchemaMerge

      boolean useMappingBasedSchemaMerge()
      Indicates, whether the mapping based schema import is used during the import with ExternalSync/ContentTransport or not.
      Returns:
      true, if enabled.
      Since:
      5.2.210906