Package de.espirit.firstspirit.client.access.editor

Interface ReferenceConstructionAgent

public interface ReferenceConstructionAgent
Agent providing means to create reference holding containers for store elements, data sets, and external URLs.
Since:
4.2.414
See Also:

  • Field Details

  • Method Details

    • create

      @NotNull @NotNull IDProviderReferenceHolder create(@NotNull @NotNull IDProvider element, @Nullable @Nullable String remoteConfigName) throws IllegalArgumentException
      Create an element referencing container from a given id providing store element. If the element originates from a remote project, the name of the according remote configuration must be given.

      Note: If the given element is of type Dataset, it must originate from a content source. This is met if the dataset is returned by a SelectStoreElementOperation.

      Parameters:
      element - The store element.
      remoteConfigName - Name of the remote configuration.
      Returns:
      A container referencing the given element.
      Throws:
      IllegalArgumentException - If a the given element and/or remote information do not satisfy the requirements for building a reference container.
      Since:
      4.2.414

    • create

      IDProviderReferenceHolder create(@NotNull @NotNull String uid, @NotNull IDProvider.UidType uidType, @Nullable @Nullable String remoteConfigName)
      Create an element referencing container on given store element information. If the element originates from a remote project, the name of the according remote configuration must be given.
      Parameters:
      uid - The element's uid.
      uidType - The element's uid type.
      remoteConfigName - Name of the remote configuration.
      Returns:
      A container referencing the given element.
      Since:
      5.2.200403

    • create

      IDProviderReferenceHolder create(@NotNull @NotNull String schemaUid, @NotNull @NotNull String entityTypeName, @NotNull @NotNull UUID gid, @Nullable @Nullable String remoteConfigName)
      Create a dataset referencing container on given information. If the dataset originates from a remote project, the name of the according remote configuration must be given.
      Parameters:
      schemaUid - The schema's uid the referenced dataset originates from.
      entityTypeName - The name of the entity type (table) in the schema.
      gid - The dataset's gid.
      remoteConfigName - Name of the remote configuration.
      Returns:
      A container referencing the given dataset.
      Since:
      5.2.200403

    • create

      IDProviderReferenceHolder create(@NotNull @NotNull String schemaUid, @NotNull @NotNull String entityTypeName, @NotNull @NotNull KeyValue keyValue, @Nullable @Nullable String remoteConfigName)
      Create a dataset referencing container on given information. If the dataset originates from a remote project, the name of the according remote configuration must be given.
      Parameters:
      schemaUid - The schema's uid the referenced dataset originates from.
      entityTypeName - The name of the entity type (table) in the schema.
      keyValue - The dataset's key value.
      remoteConfigName - Name of the remote configuration.
      Returns:
      A container referencing the given dataset.
      Since:
      5.2.200408

    • create

      @NotNull @NotNull ExternalReferenceHolder create(@NotNull @NotNull String resource, @Nullable @Nullable String category)
      Create an external referencing container from a given resource (e.g. an URL) and category.
      Parameters:
      resource - an external resource.
      category - The category of the identifier - if null the default category "url" is used.
      Returns:
      A container referencing via a resource identifier and a category.
      Since:
      4.2.414