OSID Logo
OSID Specifications
tracking package
Version 3.1.0
Interfaceosid.tracking.IssueSearchSession
Implementsosid.tracking.IssueQuerySession
Used Byosid.tracking.TrackingManager
osid.tracking.TrackingProxyManager
Description

This session provides methods for searching among Issue objects. The search query is constructed using the IssueQuery.

getIssuesByQuery() is the basic search method and returns a list of Issues. A more advanced search may be performed with getIssuesBySearch(). It accepts an IssueSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getIssuesBySearch() returns an IssueSearchResults that can be used to access the resulting IssueList or be used to perform a search within the result set through IssueSearch.

This session defines views that offer differing behaviors for searching.

  • federated front office view: searches include issues in front offices of which this front office is an ancestor in the front office hierarchy
  • isolated front office view: searches are restricted to issues in this frontOffice

Issues may have a query record indicated by their respective record types. The query record is accessed via the IssueQuery.

MethodgetIssueSearch
Description

Gets an issue search.

Returnosid.tracking.IssueSearch the issue search
Compliancemandatory This method must be implemented.
MethodgetIssueSearchOrder
Description

Gets an issue search order. The IssueSearchOrder is supplied to an IssueSearch to specify the ordering of results.

Returnosid.tracking.IssueSearchOrder the issue search order
Compliancemandatory This method must be implemented.
MethodgetIssuesBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.tracking.IssueQueryissueQuery the issue query
osid.tracking.IssueSearchissueSearch the issue search
Returnosid.tracking.IssueSearchResults the issue search results
ErrorsNULL_ARGUMENT issueQuery or issueSearch is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED issueQuery or issueSearch is not of this service
Compliancemandatory This method must be implemented.
MethodgetIssueQueryFromInspector
Description

Gets an issue query from an inspector. The inspector is available from a IssueSearchResults.

Parametersosid.tracking.IssueQueryInspectorissueQueryInspector an issue query inspector
Returnosid.tracking.IssueQuery the issue query
ErrorsNULL_ARGUMENT issueQueryInspector is null
UNSUPPORTED issueQueryInspector is not of this service
Compliancemandatory This method must be implemented.