Interface ITrackerProject

    • Method Detail

      • getTrackerPrefix

        java.lang.String getTrackerPrefix()
      • 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​(java.lang.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:
        createWorkItem(), IWorkflowObject.setType(ITypeOpt)
      • getWorkItem

        IWorkItem getWorkItem​(java.lang.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

        IPObjectList queryWorkItems​(java.lang.String query,
                                    java.lang.String sort)
      • getCategory

        ICategory getCategory​(java.lang.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​(java.lang.String id)
        Create new category and add it to the project
        Parameters:
        id -
        Returns:
        created category
      • createTimePoint

        ITimePoint createTimePoint​(java.lang.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
      • getTimePoint

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

        void deleteTimePoint​(ITimePoint timePoint)
      • 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.
      • 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
      • 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 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