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

This session provides methods to retrieve QueueConstrainerEnabler to FrontOffice mappings. a QueueConstrainerEnabler may appear in multiple FrontOffice objects. Each front office may have its own authorizations governing who is allowed to look at it.

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
MethodcanLookupQueueConstrainerEnablerFrontOfficeMappings
Description

Tests if this user can perform lookups of queue constrainer enabler/office 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.
MethoduseComparativeQueueConstrainerEnablerFrontOfficeView
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.
MethodusePlenaryQueueConstrainerEnablerFrontOfficeView
Description

A complete view of the QueueConstrainerEnabler and FrontOffice 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.
MethodgetQueueConstrainerEnablerIdsByFrontOffice
Description

Gets the list of QueueConstrainerEnablerIds associated with an FrontFront Office.

Parametersosid.id.IdfrontOfficeId Id of the FrontOffice
Returnosid.id.IdListlist of related queue constrainer enabler Ids
ErrorsNOT_FOUND frontOfficeId is not found
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerEnablersByFrontOffice
Description

Gets the list of queue constrainer enablers associated with an FrontFront Office.

Parametersosid.id.IdfrontOfficeId Id of the FrontOffice
Returnosid.tracking.rules.QueueConstrainerEnablerListlist of related queue constrainer enablers
ErrorsNOT_FOUND frontOfficeId is not found
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerEnablerIdsByFrontOffices
Description

Gets the list of QueueConstrainerEnabler Ids corresponding to a list of FrontOffices.

Parametersosid.id.IdListfrontOfficeIdslist of front office Ids
Returnosid.id.IdListlist of queue constrainer enabler Ids
ErrorsNULL_ARGUMENT frontOfficeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueConstrainerEnablersByFrontOffices
Description

Gets the list of queue constrainer enablers corresponding to a list of FrontOffices.

Parametersosid.id.IdListfrontOfficeIdslist of front office Ids
Returnosid.tracking.rules.QueueConstrainerEnablerListlist of queue constrainer enablers
ErrorsNULL_ARGUMENT frontOfficeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFrontOfficeIdsByQueueConstrainerEnabler
Description

Gets the FrontOffice Ids mapped to a QueueConstrainerEnabler.

Parametersosid.id.IdqueueConstrainerEnablerId Id of a QueueConstrainerEnabler
Returnosid.id.IdListlist of offices
ErrorsNOT_FOUND queueConstrainerEnablerId is not found
NULL_ARGUMENT queueConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFrontOfficesByQueueConstrainerEnabler
Description

Gets the FrontOffices mapped to a QueueConstrainerEnabler.

Parametersosid.id.IdqueueConstrainerEnablerId Id of a QueueConstrainerEnabler
Returnosid.tracking.FrontOfficeListlist of offices
ErrorsNOT_FOUND queueConstrainerEnablerId is not found
NULL_ARGUMENT queueConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.