Package com.polarion.alm.projects.model

Interface IProject

All Superinterfaces:
IAdaptable, IChangeListener, IGroupEntity, IHasCustomValues, IHasValues, ILocatedObject, IPObject
All Known Subinterfaces:
ITrackerProject
public interface IProject extends IGroupEntity
IPObject representation of the project.

Note: Projects and project groups are available as IPObjects so that it's easy to read them and manipulate some of their properties. However, they encapsulate lower level objects and therefore it's not possible to create and delete projects by the means of standard IPObject ways.

Author:
dobisekm
See Also:

  • Field Details

  • Method Details

    • getProjectGroup

      IProjectGroup getProjectGroup()

    • getLocation

      @NotNull ILocation getLocation()
      Returns the current location of the project folder in the repository. (The revision of this project instance is ignored.)

      Note that getValue(IGroupEntity.KEY_LOCATION) does NOT return the same value. That method returns the location of the project.xml file, and for revision projects, it returns this location within the revision.

      Specified by:
      getLocation in interface ILocatedObject
      Returns:
      The absolute location without a revision.

    • getId

      String getId()

    • getName

      String getName()

    • setName

      void setName(String name)

    • getDescription

      Text getDescription()

    • setDescription

      void setDescription(Text description)

    • getLead

      IUser getLead()

    • setLead

      void setLead(IUser lead)

    • isActive

      boolean isActive()

    • setActive

      void setActive(boolean active)

    • getLockWorkRecordsDate

      DateOnly getLockWorkRecordsDate()
      Since:
      3.3

    • setLockWorkRecordsDate

      void setLockWorkRecordsDate(DateOnly date)
      Since:
      3.3

    • setIcon

      void setIcon(@Nullable String icon)
      Sets the path to the project's icon (e.g. "/polarion/ria/images/topicIcons/project.svg").
      Since:
      3.22.2

    • getIcon

      @Nullable String getIcon()
      Returns:
      The path to the project's icon (e.g. "/polarion/ria/images/topicIcons/project.svg").
      Since:
      3.22.2

    • getIconOrDefault

      @NotNull String getIconOrDefault()
      Returns:
      The path to the project's icon (e.g. "/polarion/ria/images/topicIcons/project.svg") or the default project's icon if the icon is not set for the project.
      Since:
      3.22.2

    • getColorOrDefault

      @NotNull String getColorOrDefault()
      Returns:
      The project's background color (e.g. "#7630a1") or the default project's color if the color is not set for the project.
      Since:
      3.22.2

    • setColor

      void setColor(@Nullable String color)
      Sets the project's background color (e.g., "#7630a1"), which is used in the navigation header for the project's icon and picker.
      Since:
      3.22.2

    • getColor

      @Nullable String getColor()
      Returns:
      The project's background color (e.g. "#7630a1").
      Since:
      3.22.2