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

This session provides methods for retrieving QueueConstrainers.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated front office view: All queue constrainer methods in this session operate, retrieve and pertain to queue constrainer defined explicitly in the current front office. Using an isolated view is useful for managing QueueConstrainers with the QueueConstrainerAdminSession.
  • federated front office view: All queue constrainer 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.
  • active queue constrainer view: All queue constrainer lookup methods return active queue constrainers.
  • any status queue constrainer view: Queue constrainers of any active or inactive status are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedFrontOfficeView() and useIsolatedFrontOfficeView() behave as a radio group and one should be selected before invoking the methods in this session.

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

Tests if this user can perform QueueConstrainers 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 opt not to offer lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeQueueConstrainerView
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.
MethodusePlenaryQueueConstrainerView
Description

A complete view of the QueueConstrainer 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.
MethoduseActiveQueueConstrainerView
Description

Only active queue constrainers are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusQueueConstrainerView
Description

All active and inactive queue constrainers are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetQueueConstrainer
Description

Gets the QueueConstrainer specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned QueueConstrainer may have a different Id than requested, such as the case where a duplicate Id was assigned to a QueueConstrainer and retained for compatibility.

In active mode, queue constrainers are returned that are currently active. In any status mode, active and inactive queue constrainers are returned.

Parametersosid.id.IdqueueConstrainerId Id of the QueueConstrainer
Returnosid.tracking.rules.QueueConstrainerthe queue constrainer
ErrorsNOT_FOUND queueConstrainerId not found
NULL_ARGUMENT queueConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetQueueConstrainersByIds
Description

Gets a QueueConstrainerList corresponding to the given IdList.

In plenary mode, the returned list contains all of the queue constrainer specified in the Id list, in the order of the list, including duplicates, or an error results if a Id in the supplied list is not found or inaccessible. Otherwise, inaccessible QueueConstrainers may be omitted from the list and may present the elements in any order including returning a unique set.

In active mode, queue constrainers are returned that are currently active. In any status mode, active and inactive queue constrainers are returned.

Parametersosid.id.IdListqueueConstrainerIdsthe list of Ids to retrieve
Returnosid.tracking.rules.QueueConstrainerListthe returned QueueConstrainer list
ErrorsNOT_FOUNDa Id was not found
NULL_ARGUMENT queueConstrainerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainersByGenusType
Description

Gets a QueueConstrainerList corresponding to the given queue constrainer genus Type which does not include queue constrainer of genus types derived from the specified Type.

In plenary mode, the returned list contains all known queue constrainer or an error results. Otherwise, the returned list may contain only those queue constrainer that are accessible through this session.

In active mode, queue constrainers are returned that are currently active. In any status mode, active and inactive queue constrainers are returned.

Parametersosid.type.TypequeueConstrainerGenusTypea queue constrainer genus type
Returnosid.tracking.rules.QueueConstrainerListthe returned QueueConstrainer list
ErrorsNULL_ARGUMENT queueConstrainerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainersByParentGenusType
Description

Gets a QueueConstrainerList corresponding to the given queue constrainer genus Type and include any additional queue constrainer with genus types derived from the specified Type.

In plenary mode, the returned list contains all known queue constrainer or an error results. Otherwise, the returned list may contain only those queue constrainer that are accessible through this session.

In active mode, queue constrainers are returned that are currently active. In any status mode, active and inactive queue constrainers are returned.

Parametersosid.type.TypequeueConstrainerGenusTypea queue constrainer genus type
Returnosid.tracking.rules.QueueConstrainerListthe returned QueueConstrainer list
ErrorsNULL_ARGUMENT queueConstrainerGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainersByRecordType
Description

Gets a QueueConstrainerList containing the given queue constrainer record Type.

In plenary mode, the returned list contains all known queue constrainer or an error results. Otherwise, the returned list may contain only those queue constrainer that are accessible through this session.

In active mode, queue constrainers are returned that are currently active. In any status mode, active and inactive queue constrainers are returned.

Parametersosid.type.TypequeueConstrainerRecordTypea queue constrainer record type
Returnosid.tracking.rules.QueueConstrainerListthe returned QueueConstrainer list
ErrorsNULL_ARGUMENT queueConstrainerRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainers
Description

Gets all QueueConstrainers.

In plenary mode, the returned list contains all known queue constrainer or an error results. Otherwise, the returned list may contain only those queue constrainer that are accessible through this session.

In active mode, queue constrainers are returned that are currently active. In any status mode, active and inactive queue constrainers are returned.

Returnosid.tracking.rules.QueueConstrainerListthe returned QueueConstrainer list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.