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

This session provides methods to retrieve QueueConstrainer to Queue mappings. A Queue with multiple QueueConstrainers means any positive rule evaluation across the constrainers result in an accessible Queue.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated front office view: All methods in this session operate, retrieve and pertain queue constrainer defined explicitly in the current front office
  • federated front office view: All methods in this session operate, retrieve and pertain to all queue constrainer defined in this front office and any other queue constrainer implicitly available in this front office through front office inheritence.
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.
MethodcanLookupQueueConstrainerRules
Description

Tests if this user can perform lookups of queue constrainer/queue mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeQueueConstrainerRuleView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryQueueConstrainerRuleView
Description

A complete view of the QueueConstrainer and Queue returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedFrontOfficeView
Description

Federates the view for methods in this session. A federated view will include queue constrainer 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 lookups to this front office only.

CompliancemandatoryThis method is must be implemented.
MethodgetQueueConstrainerIdsForQueue
Description

Gets the QueueConstrainer Id associated with a Queue.

Parametersosid.id.IdqueueId Id of the Queue
Returnosid.id.IdListthe queue constrainer Ids
ErrorsNOT_FOUND queueId is not found
NULL_ARGUMENT queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainersForQueue
Description

Gets the QueueConstrainer associated with a Queue.

Parametersosid.id.IdqueueId Id of the Queue
Returnosid.tracking.rules.QueueConstrainerListthe queue constrainers
ErrorsNOT_FOUND queueId is not found
NULL_ARGUMENT queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueIdsForQueueConstrainer
Description

Gets the Queue Ids mapped to a QueueConstrainer.

Parametersosid.id.IdqueueConstrainerId Id of a QueueConstrainer
Returnosid.id.IdListlist of queue Ids
ErrorsNOT_FOUND queueConstrainerId is not found
NULL_ARGUMENT queueConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueuesForQueueConstrainer
Description

Gets the Queues mapped to a QueueConstrainer.

Parametersosid.id.IdqueueConstrainerId Id of a QueueConstrainer
Returnosid.tracking.QueueListlist of queues
ErrorsNOT_FOUND queueConstrainerId is not found
NULL_ARGUMENT queueConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.