OSID Logo
OSID Specifications
tracking package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.QueueQuerySession
Implementsosid.OsidSession
Description

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

This session defines views that offer differing behaviors for searching.

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

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

MethodgetFrontOfficeId
Description

Gets the FrontOffice Id associated with this session.

Returnosid.id.Idthe FrontOffice Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetFrontOffice
Description

Gets the FrontOffice associated with this session.

Returnosid.tracking.FrontOfficethe front office
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchQueues
Description

Tests if this user can perform Queue 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
CompliancemandatoryThis method must be implemented.
MethoduseFederatedFrontOfficeView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedFrontOfficeView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetQueueQuery
Description

Gets a queue query.

Returnosid.tracking.QueueQuerythe queue query
CompliancemandatoryThis method must be implemented.
MethodgetQueuesByQuery
Description

Gets a list of Queues matching the given queue query.

Parametersosid.tracking.QueueQueryqueueQuerythe queue query
Returnosid.tracking.QueueListthe returned QueueList
ErrorsNULL_ARGUMENT queueQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED queueQuery is not of this service
CompliancemandatoryThis method must be implemented.