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

This session manages queries and sequencing to create "smart" dynamic catalogs. A QueueQuery can be retrieved from this session and mapped to this FrontOffice to create a virtual collection of Queues. The queues may be sequenced using the QueueSearchOrder from this session.

This FrontOffice has a default query that matches any queue and a default search order that specifies no sequencing. The queries may be examined using a QueueQueryInspector. The query may be modified by converting the query inspector back to a 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.
MethodcanManageSmartFrontOffices
Description

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

Returnboolean false if smart front office management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetQueueQuery
Description

Gets a queue query.

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

Gets a queue search order.

Returnosid.tracking.QueueSearchOrderthe queue search order
CompliancemandatoryThis method must be implemented.
MethodapplyQueueQuery
Description

Applies a queue query to this front office.

Parametersosid.tracking.QueueQueryqueueQuerythe queue query
ErrorsNULL_ARGUMENT queueQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED queueQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectQueueQuery
Description

Gets a queue query inspector for this front office.

Returnosid.tracking.QueueQueryInspectorthe queue query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyQueueSequencing
Description

Applies a queue search order to this front office.

Parametersosid.tracking.QueueSearchOrderqueueSearchOrderthe queue search order
ErrorsNULL_ARGUMENT queueSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED queueSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetQueueQueryFromInspector
Description

Gets a queue query from an inspector.

Parametersosid.tracking.QueueQueryInspectorqueueQueryInspectora queue query inspector
Returnosid.tracking.QueueQuerythe queue query
ErrorsNULL_ARGUMENT queueQueryInspector is null
UNSUPPORTED queueQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.