Package com.polarion.alm.tracker.model.baselinecollection

Interface IBaselineCollection

All Superinterfaces:
IAdaptable, IChangeListener, IHasCustomValues, IHasValues, IPObject, IUniqueObject
public interface IBaselineCollection extends IUniqueObject
Since:
3.20.1

  • Field Details

  • Method Details

    • getName

      @Nullable String getName()

    • setName

      void setName(@NotNull String name)
      Name of the Collection must be set before the Collection can be saved, and must not be empty or contain only whitespace.
      Throws:
      IllegalArgumentException - if name is empty or contains only whitespace.

    • getCreated

      @Nullable Date getCreated()

    • getUpdated

      @Nullable Date getUpdated()

    • getAuthor

      @Nullable IUser getAuthor()

    • setDescription

      void setDescription(@NotNull Text description)

    • getDescription

      @Nullable Text getDescription()

    • getElements

      @NotNull List<IBaselineCollectionElement> getElements()

    • getElement

      @Nullable IBaselineCollectionElement getElement(@NotNull IPObject object)
      Returns the element for the given object if there is one. (Works with any revision.)

    • addElement

      @NotNull IBaselineCollectionElement addElement(@NotNull IPObject object)
      Adds or updates the element for the given object.

      The element's revision is set or updated to the revision of the object.

      Currently, only IModule is allowed as the collection element's object.

      Returns:
      the existing or created element for the object.
      Throws:
      IllegalArgumentException - if the object is not of a supported prototype.

    • removeElement

      void removeElement(@NotNull IPObject object)
      Removes the element for the given object if there is one. (Ignores revision.)

    • delete

      void delete()

    • getClosedOn

      @Nullable Date getClosedOn()

    • setReusedFrom

      void setReusedFrom(@Nullable IBaselineCollection from)
      Since:
      3.20.2

    • getReusedFrom

      @Nullable IBaselineCollection getReusedFrom()
      Since:
      3.20.2

    • setBranchedFrom

      void setBranchedFrom(@Nullable IBaselineCollection from)
      Since:
      3.21.2

    • getBranchedFrom

      @Nullable IBaselineCollection getBranchedFrom()
      Since:
      3.21.2

    • addUpstreamCollection

      void addUpstreamCollection(@NotNull IBaselineCollection collection)
      Adds a Collection to the list of upstream Collections, or updates the Collection's revision if it is already present. A Collection with no revision will be rejected.
      Throws:
      RuntimeException - if the IBaselineCollection does not have a revision.
      Since:
      3.24.10

    • removeUpstreamCollection

      void removeUpstreamCollection(@NotNull IBaselineCollection collection)
      Removes the given Collection from the list of upstream Collections. Ignores the revision.
      Since:
      3.24.10

    • getUpstreamCollections

      @NotNull List<IBaselineCollection> getUpstreamCollections()
      Returns:
      immutable list of direct upstream Collections.
      Since:
      3.24.10

    • getDownstreamCollections

      @NotNull List<IBaselineCollection> getDownstreamCollections()
      Returns:
      A list of direct downstream Collections.
      Since:
      3.24.10