Package com.polarion.alm.tracker

Interface ITrackerService

public interface ITrackerService
The main entry point for tracker-related functionalities. The functionality is devided by domains into the individual managers.
Author:
dobisekm

  • Method Details

    • getDataService

      IDataService getDataService()
      Returns the base data service instance used by this tracker service.
      Returns:
      the base IDataService object representing the data service used by this tracker service

    • getProjectsService

      IProjectService getProjectsService()
      Returns the project service used by this tracker service.
      Returns:
      the IProjectService object representing the project service used by this tracker service

    • getModuleManager

      IModuleManager getModuleManager()
      Since:
      3.2

    • getRichPageManager

      @NotNull IRichPageManager getRichPageManager()
      Returns the manager for IRichPage
      Since:
      3.9.0

    • getExportManager

      IExportManager getExportManager()
      Returns the export manager.
      Returns:
      the IExportManager object representing the export manager

    • getImportManager

      IImportManager getImportManager()
      Returns the import manager.
      Returns:
      the IImportManager object representing the import manager

    • getPlanningManager

      IPlanningManager getPlanningManager()
      Returns the planning manager.
      Returns:
      the IPlanningManager object representing the planning manager

    • getVotingManager

      IVotingManager getVotingManager()
      Returns the voting manager.
      Returns:
      the IVotingManager object representing the voting manager

    • getWorkflowManager

      IWorkflowManager getWorkflowManager()
      Returns the workflow manager.
      Returns:
      the IWorkflowManager object representing the workflow manager

    • getTrackerUser

      ITrackerUser getTrackerUser(IUser user)
      Returns a tracker user.
      Parameters:
      user - the IUser object representing the user to get the tracker user for
      Returns:
      a ITrackerUser object representing the tracker user for the given user

    • getTrackerUser

      ITrackerUser getTrackerUser(String userId)
      Returns a tracker user for the specified user id. The tracker user object is unresolved, it is not guaranteed that such an user exists.
      Parameters:
      userId - the String representing the id of the user to get the tracker user for
      Returns:
      a ITrackerUser object representing the tracker user for the specified userId, never null

    • getTrackerProject

      ITrackerProject getTrackerProject(IProject project)
      Returns a tracker project.
      Parameters:
      project - the IProject representing the project to get the tracker project for
      Returns:
      a ITrackerProject object representing the tracker project for the specified project

    • getTrackerProject

      ITrackerProject getTrackerProject(String projectId)
      Returns a tracker project for the specified project id. The tracker project object is unresolved, it is not guaranteed that such a project exists.
      Parameters:
      projectId - the String representing the id of the project to get the tracker project for
      Returns:
      a ITrackerProject object representing the tracker project for the specified projectId, never null

    • getTrackerRevision

      ITrackerRevision getTrackerRevision(IRevision revision)
      Returns a tracker revision.
      Parameters:
      revision - the IRevision representing the revision to get the tracker revision for
      Returns:
      a ITrackerRevision object representing the tracker revision for the specified revision

    • createWorkItem

      IWorkItem createWorkItem(IProject project)
      Creates a new (unpersisted) work item in given project. The work item will be persisted when its save() method is called.
      Parameters:
      project - project the IProject object to create the work item for
      Returns:
      the unpersisted IWorkItem object

    • getWorkItem

      IWorkItem getWorkItem(String projectId, String workItemId)
      This is a shortcut method for getTrackerProject(projectId).getWorkItem(workItemId), see ITrackerProject.getWorkItem(String).

    • findWorkItem

      IWorkItem findWorkItem(String projectId, String id)
      Finds work item, differs from getWorkItem(String, String) in smarter handling of the id parameter.
      Parameters:
      projectId - - is ignored when the id is in format projectId/id
      id - - can be in format projectId/id - in this case the first parameter is ignored, can be null
      Since:
      3.5.3

    • getWorkItem

      IWorkItem getWorkItem(SubterraURI uri)
      Returns the workitem with the specified uri. This is a shortcut method for (IWorkItem)getDataservice.getInstance(uri), see IDataService.getInstance(SubterraURI).
      Parameters:
      uri - the SubterraURI object to get the workitem for
      Returns:
      unresolved IWorkItem object

    • queryWorkItems

      IPObjectList queryWorkItems(String query, String sort)
      Returns the workitems matching the specified query. The list is sorted using the specified sort key.
      Parameters:
      query - the String object representing the query used for searching workitems
      sort - the format is same as for IIndexSearch.sort(String)
      Returns:
      a List object containing the IWorkItems found for the query

    • queryWorkItems

      IPObjectList queryWorkItems(IProject project, String query, String sort)
      Returns the workitems of the specified project matching the specified query. The list is sorted using the specified sort key.
      Parameters:
      project - the IProject object representing the project to query workitems for
      query - the String object representing the query used for searching workitems
      sort - the format is same as for IIndexSearch.sort(String)
      Returns:
      a List object containing the IWorkItems found for the query

    • queryWorkItemsInBaseline

      IPObjectList queryWorkItemsInBaseline(String query, String sort, String baselineRevision)
      Returns the Work Items matching the specified query. The list is sorted using the specified fields.
      Parameters:
      query - query used for searching Work Items (can be null)
      sort - the format is same as for IIndexSearch.sort(String)
      baselineRevision - baseline revision (not null)
      Returns:
      IPObjectList of IWorkItems (never null)
      Since:
      3.6.0

    • getLinkedWIsDirectQueryFromMessage

      String getLinkedWIsDirectQueryFromMessage(String commitMessage)
      Returns a query which finds all which are mentioned in the commit message.
      Parameters:
      commitMessage - a String object representing the message which to create the query for
      Returns:
      a String object representing the query, usable to search for items mentioned in the message

    • getLinkedWIsDirectFromLogMessage

      IPObjectList getLinkedWIsDirectFromLogMessage(String commitMessage)
      Searches the items, which are mentioned in the commit message.
      Parameters:
      commitMessage - the String representing the commit message to search contained work items for
      Returns:
      a List object containing the IWorkItems mentioned in the commitMessage

    • getSavedQueriesManager

      ISavedQueriesManager getSavedQueriesManager()
      Returns the saved queries manager.
      Returns:
      the ISavedQueriesManager object representing the saved queries manager

    • getTimePointsManager

      ITimePointsManager getTimePointsManager()
      Returns the timepoint manager.
      Returns:
      the ITimePointManager object representing the timepoint manager

    • getWorkItemLinkRolesManager

      IWorkItemLinkRolesManager getWorkItemLinkRolesManager()
      Returns the link roles manager.
      Returns:
      the IWorkItemLinkRolesManager object representing the link roles manager

    • isAutoSuspectOn

      boolean isAutoSuspectOn(IWorkItem workitem)
      Checks if autosuspect is enabled for a given work item.
      Parameters:
      workitem - the IWorkItem object to check for auto suspect
      Returns:
      true if auto suspect is enabled for the given work item

    • isAutoSuspectOn

      boolean isAutoSuspectOn(IContextId contextId)
      Checks if autosuspect is enabled for a given contextId.
      Parameters:
      contextId - context
      Returns:
      true if auto suspect is enabled for the given contextId
      Since:
      3.5

    • getTrackerPolicy

      ITrackerPolicy getTrackerPolicy()
      Returns the tracker policy.
      Returns:
      a ITrackerPolicy object representing the tracker policy

    • loadExternallyLinkedWorkItems

      List<ITrackerService.IExternallyLinkedWorkItem> loadExternallyLinkedWorkItems(List<IExternalWorkItemURI> externallyLinkedWorkItems, String[] fields, boolean loadEnumerations, Map<String,IUserCredentials> hostCredentials)
      Loads external work items.
      Parameters:
      externallyLinkedWorkItems - URIs of external work items (not null)
      fields - fields to load into ITrackerService.IExternallyLinkedWorkItem.getWorkItem() (see TrackerWebService.getWorkItemByIdsWithFields(String, String, String[]) for more information)
      loadEnumerations - true if ITrackerService.IExternallyLinkedWorkItem.getType() and ITrackerService.IExternallyLinkedWorkItem.getStatus() should be loaded
      hostCredentials - map of user credentials for externally linked work items. Key of the map is host.
      Returns:
      loaded work items (not null)
      Since:
      3.5.0

    • getExternalWorkItemURI

      IExternalWorkItemURI getExternalWorkItemURI(URI uri)
      Wraps normal URI into URI of external work item.
      Parameters:
      uri - URI (not null)
      Returns:
      external work item URI
      Throws:
      IllegalArgumentException - if given URI is not valid external work item URI
      Since:
      3.5.0

    • isExternalLinkingEnabled

      boolean isExternalLinkingEnabled(IContextId context)
      Is external work item linking enabled for given context?
      Parameters:
      context - context
      Returns:
      true if external linking is enabled
      Since:
      3.5.0

    • getWordRoundTripService

      com.polarion.alm.tracker.roundtrip.IWordRoundTripService getWordRoundTripService()
      INTERNAL This method is not part of Polarion API.
      Since:
      3.5.0

    • getGlobalLanguageDefinitionsProvider

      ILanguageDefinitionsProvider getGlobalLanguageDefinitionsProvider()
      Returns instance of ILanguageDefinitionsProvider with global language definitions.
      Returns:
      provider instance (never null)
      Since:
      3.6.2
      See Also:

    • getWorkItemWithRevision

      IWorkItem getWorkItemWithRevision(String projectId, String workItemId, String revision)
      Since:
      3.7.2

    • getAssignableUsers

      @NotNull IPObjectList<IUser> getAssignableUsers(@Nullable IContextId contextId)
      Returns users with global role "assignable", or context role "project_assignable" (if context ID is provided).
      Returns:
      users sorted by name
      Since:
      3.8.2

    • getApproverUsers

      @NotNull IPObjectList<IUser> getApproverUsers(@Nullable IContextId contextId)
      Returns users with global role "approver", or context role "project_approver" (if context ID is provided).
      Returns:
      users sorted by name
      Since:
      3.8.2

    • getFolderManager

      @NotNull IFolderManager getFolderManager()
      Returns instance of IFolderManager.
      Since:
      3.8.3

    • isOslcLinkingEnabled

      @Deprecated boolean isOslcLinkingEnabled(@Nullable IContextId context)
      Deprecated.
      Returns always true!
      Is OSLC resource linking enabled for given context?
      Parameters:
      context - context to check null to check global configuration.
      Returns:
      Returns always true!
      Since:
      3.10.1

    • getBaselineCollectionsManager

      @NotNull IBaselineCollectionsManager getBaselineCollectionsManager()
      Since:
      3.20.1

    • getWatchListManager

      @NotNull IWatchListManager getWatchListManager()
      Since:
      3.23.4

    • getScriptManager

      @NotNull IScriptManager getScriptManager()
      WARNING: Not yet part of the API.
      Since:
      3.24.10