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

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

This session defines views that offer differing behaviors for searching.

  • federated front office view: searches include queue constrainer enablers in front office of which this front office is an ancestor in the front office hierarchy
  • isolated front office view: searches are restricted to queue constrainer enablers in this office

Queue constrainer enablers may have a query record indicated by their respective record types. The query record is accessed via the QueueConstrainerEnablerQuery.

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.
MethodcanSearchQueueConstrainerEnablers
Description

Tests if this user can perform QueueConstrainerEnabler 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 queue constrainer enablers in front offices which are children of this queue 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 lookups to this front office only.

CompliancemandatoryThis method is must be implemented.
MethodgetQueueConstrainerEnablerQuery
Description

Gets a queue constrainer enabler query.

Returnosid.tracking.rules.QueueConstrainerEnablerQuerythe queue constrainer enabler query
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerEnablersByQuery
Description

Gets a list of QueueConstrainerEnablers matching the given queue constrainer enabler query.

Parametersosid.tracking.rules.QueueConstrainerEnablerQueryqueueConstrainerEnablerQuerythe sequeue constrainer enabler query
Returnosid.tracking.rules.QueueConstrainerEnablerListthe returned QueueConstrainerEnablerList
ErrorsNULL_ARGUMENT queueConstrainerEnablerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED queueConstrainerEnablerQuery is not of this service
CompliancemandatoryThis method must be implemented.