Package de.espirit.firstspirit.agency

Interface ProjectReferencesAgent

public interface ProjectReferencesAgent
Agent to recalculate the reference graph of a single element or the complete project.
Since:
5.2.301

  • Field Details

  • Method Details

    • rebuildReferences

      void rebuildReferences()
      Rebuild reference for all elements from all current and release stores.
      Since:
      5.2.301

    • isRebuildingReferences

      boolean isRebuildingReferences()
      Returns if rebuilding of all references is in progress.
      Returns:
      true if rebuilding is in progress, false otherwise.
      Since:
      5.2.301
      See Also:

    • rebuildReferences

      void rebuildReferences(IDProvider element)
      Recalculates the outgoing references of the given element.
      Important: Incoming references won't be fixed, missing or wrong incoming references must be fixed by rebuilding the references of the source element.
      Parameters:
      element - The element for which the outgoing references will be recalculated.
      Since:
      5.2.301

    • getBrokenReferences

      List<ReferenceEntry> getBrokenReferences(boolean release)
      Get all broken references from all current or release stores.
      Parameters:
      release - Provide true for references from release stores and false for references from current stores.
      Returns:
      The list of broken references.
      Since:
      5.2.301
      See Also:

    • getExternalReferences

      List<ReferenceEntry> getExternalReferences(@Nullable @Nullable String category, boolean release)
      Get all external references from the current or from the release stores.
      Parameters:
      release - Provide true for references from release stores and false for references from current stores.
      category - External reference category or null for external references from all categories.
      Returns:
      A list of external references.
      Since:
      5.2.301