Package de.espirit.firstspirit.client.plugin.dataaccess.aspects

Interface ValueReferencesJournal

public interface ValueReferencesJournal
Defines a journal for references.
Since:
5.2.181205

  • Method Details

    • addReferenceToElement

      void addReferenceToElement(@NotNull @NotNull IDProvider element)
      Adds a reference to a FirstSpirit element to this journal.
      Parameters:
      element - The element being referenced.
      Since:
      5.2.181205

    • addReferenceToExternal

      void addReferenceToExternal(@NotNull @NotNull String category, @NotNull @NotNull String reference)
      Adds a reference to an external element to this journal. The category identifier should be unique to the referrer to enable good discoverability via the ProjectReferencesAgent.
      Parameters:
      category - A category identifier.
      reference - The reference descriptor.
      Since:
      5.2.181205

    • addBrokenReferenceToElement

      @Deprecated void addBrokenReferenceToElement(@NotNull @NotNull String uid, @NotNull IDProvider.UidType uidType, @Nullable @Nullable String remote)
      Deprecated.
      since 5.2.200403 - use addReferenceToElement(String, IDProvider.UidType, String) instead
      Adds a reference to a FirstSpirit element to this journal, where the actual referenced element could not be found (e.g., may be deleted from the project). Such a broken reference is identified by the element's unique identifier and uid type. If the element originates from a remote project, its configuration name must be provided.
      Parameters:
      uid - The element's uid.
      uidType - The element's uid type.
      remote - The configuration name of the remote project, if applicable.
      Since:
      5.2.181205

    • addReferenceToElement

      default void addReferenceToElement(@NotNull @NotNull String uid, @NotNull IDProvider.UidType uidType, @Nullable @Nullable String remote)
      Adds a reference to a FirstSpirit element to this journal. Such a reference is identified by the element's unique identifier and uid type. If the element originates from a remote project, its configuration name must be provided.
      Parameters:
      uid - The element's uid.
      uidType - The element's uid type.
      remote - The configuration name of the remote project, if applicable.
      Since:
      5.2.200403

    • addBrokenReferenceToDataset

      @Deprecated void addBrokenReferenceToDataset(@NotNull @NotNull Schema schema, @NotNull @NotNull String entityTypeName, @NotNull @NotNull UUID gid)
      Deprecated.
      since 5.2.200403 - use addReferenceToDataset(Schema, String, UUID) instead
      Adds a reference to a FirstSpirit Dataset to this journal, where the referenced dataset could not be found (e.g., may be deleted from the project). Such a broken reference here is identified by the schema it originated from, the name of its entity type (table name) and the global identifier.
      Parameters:
      schema - The schema the referenced dataset originates from
      entityTypeName - The name of the entity type (table) in the schema.
      gid - The global identifier of the referenced dataset.
      Since:
      5.2.181205

    • addReferenceToDataset

      default void addReferenceToDataset(@NotNull @NotNull Schema schema, @NotNull @NotNull String entityTypeName, @NotNull @NotNull UUID gid)
      Adds a reference to a FirstSpirit Dataset to this journal. Such a reference here is identified by the schema it originated from, the name of its entity type (table name) and the global identifier.
      Parameters:
      schema - The schema the referenced dataset originates from
      entityTypeName - The name of the entity type (table) in the schema.
      gid - The global identifier of the referenced dataset.
      Since:
      5.2.200403

    • addReferenceToDataset

      void addReferenceToDataset(@NotNull @NotNull Schema schema, @NotNull @NotNull String entityTypeName, @NotNull @NotNull KeyValue keyValue)
      Adds a reference to a FirstSpirit Dataset to this journal. Such a reference here is identified by the schema it originated from, the name of its entity type (table name) and the key value.
      Parameters:
      schema - The schema the referenced dataset originates from
      entityTypeName - The name of the entity type (table) in the schema.
      keyValue - The key value of the referenced dataset.
      Since:
      5.2.200408