OSID Logo
OSID Specifications
tracking package
Version 3.1.0
Interfaceosid.tracking.IssueQuerySession
Implementsosid.OsidSession
Implemented Byosid.tracking.IssueSearchSession
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.

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 record query is accessed via the IssueQuery.

MethodgetFrontOfficeId
Description

Gets the FrontOffice Id associated with this session.

Returnosid.id.Id the FrontOffice Id associated with this session
Compliancemandatory This method must be implemented.
MethodgetFrontOffice
Description

Gets the FrontOffice associated with this session.

Returnosid.tracking.FrontOffice the front office
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodcanSearchIssues
Description

Tests if this user can perform Issue lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethoduseFederatedFrontOfficeView
Description

Federates the view for methods in this session. A federated view will include issues in front offices which are children of this front office in the front office hierarchy.

Compliancemandatory This method is must be implemented.
MethoduseIsolatedFrontOfficeView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this front office only.

Compliancemandatory This method is must be implemented.
MethodgetIssueQuery
Description

Gets an issue query.

Returnosid.tracking.IssueQuery the issue query
Compliancemandatory This method must be implemented.
MethodgetIssuesByQuery
Description

Gets a list of Issues matching the given issue query.

Parametersosid.tracking.IssueQueryissueQuery the issue query
Returnosid.tracking.IssueList the returned IssueList
ErrorsNULL_ARGUMENT issueQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED issueQuery is not of this service
Compliancemandatory This method must be implemented.