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

This session manages queries and sequencing to create "smart" dynamic front office. a QueueConstrainerQuery can be retrieved from this session and mapped to this FrontOffice to create a virtual collection of queue constrainers. The queue constrainer may be sequenced using the QueueConstrainerSearchOrder from this session.

This FrontOffice has a default query that matches any queue constrainer and a default search order that specifies no sequencing. The queries may be examined using a QueueConstrainerQueryInspector. The query may be modified by converting the inspector back to a QueueConstrainerQuery.

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 office
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartFrontOffices
Description

Tests if this user can manage smart front office. 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.
MethodgetQueueConstrainerQuery
Description

Gets a queue constrainer query.

Returnosid.tracking.rules.QueueConstrainerQuerythe queue constrainer query
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerSearchOrder
Description

Gets a queue constrainer search order.

Returnosid.tracking.rules.QueueConstrainerSearchOrderthe queue constrainer search order
CompliancemandatoryThis method must be implemented.
MethodapplyQueueConstrainerQuery
Description

Applies a queue constrainer query to this front office.

Parametersosid.tracking.rules.QueueConstrainerQueryqueueConstrainerQuerythe queue constrainer query
ErrorsNULL_ARGUMENT queueConstrainerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED queueConstrainerQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectQueueConstrainerQuery
Description

Gets a queue constrainer query inspector for this front office.

Returnosid.tracking.rules.QueueConstrainerQueryInspectorthe queue constrainer query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyQueueConstrainerSequencing
Description

Applies a queue constrainer search order to this front office.

Parametersosid.tracking.rules.QueueConstrainerSearchOrderqueueConstrainerSearchOrderthe queue constrainer search order
ErrorsNULL_ARGUMENT queueConstrainerSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED queueConstrainerSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerQueryFromInspector
Description

Gets a queue constrainer query from an inspector.

Parametersosid.tracking.rules.QueueConstrainerQueryInspectorqueueConstrainerQueryInspectora queue constrainer query inspector
Returnosid.tracking.rules.QueueConstrainerQuerythe queue constrainer query
ErrorsNULL_ARGUMENT queueConstrainerQueryInspector is null
UNSUPPORTED queueConstrainerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.