Interface IBaseline

All Superinterfaces:
IAdaptable, IChangeListener, IHasCustomValues, IHasValues, IPObject, IUniqueObject

public interface IBaseline extends IUniqueObject
Baselines represent a state (represented by a base revision) in the history of an object (a base object) from the Project that contains the Baseline. The base object can also be the Project itself, in which case the Baseline represents a state of the whole project.
  • Field Details

  • Method Details

    • getName

      @Nullable String getName()
    • setName

      void setName(@Nullable String name)
      Since:
      3.19.2
    • getDescription

      @Deprecated String getDescription()
      Deprecated.
      As of 3.19.2 use getDescriptionText() instead.
    • getDescriptionText

      @Nullable Text getDescriptionText()
      Since:
      3.19.2
    • setDescription

      void setDescription(@Nullable Text description)
      Since:
      3.19.2
    • getAuthor

      IUser getAuthor()
    • getBaseRevision

      String getBaseRevision()
    • getBaseRevisionObject

      @Nullable IRevision getBaseRevisionObject()
      Returns the IRevision object corresponding to the base revision. Returns null if the base revision is not filled-in.
      Since:
      3.19.2
    • getBaseObject

      @Nullable <T extends IPObject> T getBaseObject()
      Returns the base object in the base revision of this baseline. Currently the base object can only be a Project or a Document (Module).

      Since:
      3.19.2
    • delete

      void delete()
      Since:
      3.19.2