Package com.polarion.alm.tracker

Interface ITimePointsManager

public interface ITimePointsManager

  • Method Details

    • createTimePoint

      ITimePoint createTimePoint(IContextId contextId, String id, DateOnly date)
      Creates time point in given context.
      Parameters:
      contextId - context id
      id - time point id
      date - time point date
      Returns:
      created (but not yet persisted) time point
      Since:
      3.4.0

    • getTimePoint

      ITimePoint getTimePoint(IContextId contextId, String id, boolean traverseUp)
      Returns time point with given id.
      Parameters:
      contextId - context id
      id - time point id
      traverseUp - whether to traverse up in context hierarchy if not found in current context
      Returns:
      time point (not null, but can be unresolvable)
      Since:
      3.4.0

    • getTimePoints

      IPObjectList getTimePoints(IContextId contextId, String query, String sort, boolean traverseUp, boolean traverseDown, boolean omitDuplicates)
      Searches for time points (all-purpose method).
      Parameters:
      contextId - context id to start search at
      query - query (can be null)
      sort - the format is same as for IIndexSearch.sort(String)
      traverseUp - true if all parent contexts of given context should be searched in
      traverseDown - true if all child contexts of given context should be searched in
      omitDuplicates - true if duplicates should be omitted (children have precedence over parents) - note that duplicates in different branches of the context tree are not omitted
      Returns:
      ITimePoints (not null)
      Since:
      3.4.0

    • getTimePoints

      @Deprecated IPObjectList getTimePoints(String projectid)
      Deprecated.
      use getTimePoints(IContextId, String, boolean)
      Gets all timepoints for a project.
      Parameters:
      projectid - the id of the project to get the timepoints for
      Returns:
      a List containing the ITimePoints

    • getTimePoints

      IPObjectList getTimePoints(IContextId contextId, String sort, boolean traverseDown)
      Returns all time points applicable to given context.

      Traverses both up and down in the hierarchy (if selected) and omits duplicates.

      Parameters:
      contextId -
      sort - the format is same as for IIndexSearch.sort(String)
      traverseDown - true if all child contexts of given context should be searched in
      Returns:
      ITimePoints (not null)
      Since:
      3.4.0

    • getNotClosedTimePoints

      @Deprecated IPObjectList getNotClosedTimePoints(String projectid)
      Deprecated.
      use getNotClosedTimePoints(IContextId, String, boolean)
      Gets all timepoints, that are not closed for a project.
      Parameters:
      projectid - the id of the project to get the timepoints for
      Returns:
      a List containing the ITimePoints that are not closed

    • getNotClosedTimePoints

      IPObjectList getNotClosedTimePoints(IContextId contextId, String sort, boolean traverseDown)
      Returns all not closed time points applicable to given context.

      Traverses both up and down in the hierarchy (if selected) and omits duplicates.

      Parameters:
      contextId -
      sort - the format is same as for IIndexSearch.sort(String)
      traverseDown - true if all child contexts of given context should be searched in
      Returns:
      ITimePoints (not null)
      Since:
      3.4.0

    • getClosedTimePoints

      @Deprecated IPObjectList getClosedTimePoints(String projectid)
      Deprecated.
      use getClosedTimePoints(IContextId, String, boolean)
      Gets all timepoints, that are closed for a project.
      Parameters:
      projectid - the id of the project to get the timepoints for
      Returns:
      a List containing the ITimePoints that are closed

    • getClosedTimePoints

      IPObjectList getClosedTimePoints(IContextId contextId, String sort, boolean traverseDown)
      Returns all closed time points applicable to given context.

      Traverses both up and down in the hierarchy (if selected) and omits duplicates.

      Parameters:
      contextId -
      sort - the format is same as for IIndexSearch.sort(String)
      traverseDown - true if all child contexts of given context should be searched in
      Returns:
      ITimePoints (not null)
      Since:
      3.4.0

    • getWorkItemsFromTimepoint

      IPObjectList getWorkItemsFromTimepoint(ITimePoint timePoint)

    • deleteTimePoint

      String deleteTimePoint(ITimePoint timePoint)
      Deletes a timepoint.
      Parameters:
      timePoint - the timepoint to delete.
      Returns:
      null if operation succeeds or cause of failure if deleting it is not possible (timepoint is used by a work item)

    • getNearestTimePoint

      @Deprecated ITimePoint getNearestTimePoint(String projectid)
      Deprecated.
      use getNearestTimePoint(IContextId, boolean)
      Gets the nearest timepoint for a project.
      Parameters:
      projectid - the id of the project to get the timepoint for
      Returns:
      the nearest ITimePoint for the project

    • getNearestTimePoint

      ITimePoint getNearestTimePoint(IContextId contextId, boolean traverseDown)
      Returns nearest time point applicable to given context.

      Traverses both up and down in the hierarchy (if selected).

      Parameters:
      contextId - context id
      traverseDown - true if all child contexts of given context should be searched in
      Returns:
      time point or null if none found
      Since:
      3.4.0