Package com.polarion.alm.tracker.model

Interface ITrackerProject

All Superinterfaces:
IAdaptable, IChangeListener, IGroupEntity, IHasCustomValues, IHasValues, ILocatedObject, IPObject, IProject
public interface ITrackerProject extends IProject
Author:
POLARION SOFTWARE

  • Field Details

  • Method Details

    • getTrackerService

      ITrackerService getTrackerService()
      Since:
      3.5.2

    • getTrackerPrefix

      String getTrackerPrefix()

    • getStart

      DateOnly getStart()

    • getFinish

      DateOnly getFinish()

    • createWorkItem

      IWorkItem createWorkItem()
      Creates new (unpersisted) instance of work item in this project. It is not persisted in any way, unless it's saved.
      Returns:
      a new IWorkItem

    • createWorkItem

      IWorkItem createWorkItem(String typeId)
      Shortcut method, which creates a work item instance with the type field set.
      Parameters:
      typeId - the work item type ID to set. The type ID is not checked for validity!
      Returns:
      a new IWorkItem with the specified type set
      See Also:

    • getWorkItem

      IWorkItem getWorkItem(String workItemId)
      Returns a work item for the specified id. The returned work item is unresolved and it is not guaranteed that it exists.
      Parameters:
      workItemId -
      Returns:
      an unresolved IWorkItem object representing the workitem with the given id, never null

    • queryWorkItems

      @NotNull IPObjectList<IWorkItem> queryWorkItems(@Nullable String query, @Nullable String sort)
      Parameters:
      query -
      sort - the format is same as for IIndexSearch.sort(String)

    • getCategories

      IPObjectList getCategories()
      Returns the immutable list of all ICategoryies in this project.
      See Also:

    • getCategory

      ICategory getCategory(String categoryId)
      Parameters:
      categoryId -
      Returns:
      Returns unresolved non null instance, regardless of whether such category exists.

    • deleteCategory

      void deleteCategory(ICategory category)
      Remove the category object from the project and delete it
      Parameters:
      category - to delete

    • createCategory

      ICategory createCategory(String id)
      Create new category and add it to the project
      Parameters:
      id -
      Returns:
      created category

    • createTimePoint

      ITimePoint createTimePoint(String id, DateOnly date)
      Create new time point and add it to the project
      Parameters:
      id - - id of new time point
      date - - date of a time point
      Returns:
      created time point

    • getTimePoints

      IPObjectList getTimePoints()
      Returns the immutable list of all ITimePoints in this project sorted by time (oldest time points first).
      See Also:

    • getTimePoint

      ITimePoint getTimePoint(String timePointId)
      Parameters:
      timePointId -
      Returns:
      Returns unresolved non null instance, regardless of whether such time point exists.

    • deleteTimePoint

      void deleteTimePoint(ITimePoint timePoint)

    • getClosedTimePoints

      IPObjectList getClosedTimePoints()

    • getNotClosedTimePoints

      IPObjectList getNotClosedTimePoints()

    • getNearestTimePoint

      ITimePoint getNearestTimePoint()
      Returns:
      The time point, whose date is first approaching in the future. Returns null if no such time point exists in this project.

    • getBaselinesManager

      @NotNull IBaselinesManager getBaselinesManager()

    • getWorkItemTypeEnum

      IEnumeration<ITypeOpt> getWorkItemTypeEnum()
      Returns the work item types enumeration available in this project. The enumeration options are ITypeOpt instances.

    • getModuleTypeEnum

      @Nullable IEnumeration<ITypeOpt> getModuleTypeEnum()
      Returns the module types enumeration available in this project. The enumeration options are ITypeOpt instances.
      Since:
      3.17.2

    • getWorkItemLinkRoleEnum

      IEnumeration<ILinkRoleOpt> getWorkItemLinkRoleEnum()
      Returns the work item link roles enumeration available in this project. The enumeration options are ILinkRoleOpt instances.
      Returns:
      not null

    • getOSLCItemLinkRoleEnum

      @NotNull IEnumeration getOSLCItemLinkRoleEnum()
      Returns the OSLC item link roles enumeration available in this project. The enumeration options are IEnumOption instances.
      Returns:
      not null

    • getApprovalStatusEnum

      IEnumeration<IApprovalStatusOpt> getApprovalStatusEnum()
      Returns the approval status enumeration available in this project. The enumeration options are IApprovalStatusOpt instances.
      Returns:
      not null

    • getResolutionEnum

      IEnumeration getResolutionEnum()
      Returns the resolution enumeration available in this project. The enumeration options are IResolutionOpt instances.
      Returns:
      not null

    • getPlanningConstraintsSet

      IEnumeration getPlanningConstraintsSet()
      Returns:
      not null

    • getSeverityEnum

      IEnumeration getSeverityEnum()
      Returns the severity enumeration available in this project. The enumeration options are ISeverityOpt instances.
      Returns:
      not null

    • getStatusEnum

      IEnumeration getStatusEnum()
      Returns the status enumeration available in this project. The enumeration options are IStatusOpt instances.
      Returns:
      not null

    • getPriorityEnum

      IPriorityEnumeration getPriorityEnum()
      Returns the priority enumeration available in this project. The enumeration options are IPriorityOpt instances.
      Returns:
      not null

    • getHyperlinkRoleEnum

      IEnumeration<IHyperlinkRoleOpt> getHyperlinkRoleEnum()
      Returns the hyperlink link roles enumeration available in this project. The enumeration options are IHyperlinkRoleOpt instances.
      Returns:
      not null

    • getWorkRecordTypeEnum

      IEnumeration getWorkRecordTypeEnum()
      Returns the work record type enumeration available in this project. The enumeration options are ITypeOpt instances.
      Returns:
      not null
      Since:
      3.3

    • getSignatureVerdictEnum

      @NotNull IEnumeration<ISignatureVerdictOpt> getSignatureVerdictEnum()
      Returns the signature verdict enumeration.
      Since:
      3.9.0

    • getSignatureStateEnum

      @NotNull IEnumeration<ISignatureStateOpt> getSignatureStateEnum()
      Returns the signature state enumeration.
      Since:
      3.9.0

    • getLanguageDefinitionsProvider

      ILanguageDefinitionsProvider getLanguageDefinitionsProvider()
      Returns instance of ILanguageDefinitionsProvider with language definitions related to this project.
      Returns:
      provider instance (never null)
      Since:
      3.6.1
      See Also:

    • can

      @NotNull ITrackerProjectPermissions can()
      Specified by:
      can in interface IPObject
      Since:
      3.8.2

    • getFolders

      @NotNull List<IFolder> getFolders()
      Returns list of IFolder sorted ascending by IFolder.getTitleOrName().
      Since:
      3.8.3

    • getDocumentSigners

      @NotNull IPObjectList<IUser> getDocumentSigners()
      Returns users that are allowed to sign documents in the project.
      It does not count with a custom set permissions that are defined for each document.
      Returns:
      users sorted by name
      Since:
      3.9.0
      See Also: