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

This session provides methods to retrieve Queue to FrontOffice mappings. A Queue 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
MethodcanLookupQueueFrontOfficeIssues
Description

Tests if this user can perform lookups of queue/front 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.
MethoduseComparativeQueueFrontOfficeView
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.
MethodusePlenaryQueueFrontOfficeView
Description

A complete view of the Queue 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.
MethodgetQueueIdsByFrontOffice
Description

Gets the list of Queue Ids associated with a FrontOffice.

Parametersosid.id.IdfrontOfficeId Id of the FrontOffice
Returnosid.id.IdListlist of related queue 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.
MethodgetQueuesByFrontOffice
Description

Gets the list of Queues associated with a FrontOffice.

Parametersosid.id.IdfrontOfficeId Id of the FrontOffice
Returnosid.tracking.QueueListlist of related queues
ErrorsNOT_FOUND frontOfficeId is not found
NULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetQueueIdsByFrontOffices
Description

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

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

Gets the list of Queue corresponding to a list of FrontOffices.

Parametersosid.id.IdListfrontOfficeIdslist of front office Ids
Returnosid.tracking.QueueListlist of queues
ErrorsNULL_ARGUMENT frontOfficeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFrontOfficeIdsByQueue
Description

Gets the FrontOffice Ids frontOfficeped to a Queue.

Parametersosid.id.IdqueueId Id of a Queue
Returnosid.id.IdListlist of frontOffices
ErrorsNOT_FOUND queueId is not found
NULL_ARGUMENT queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetFrontOfficesByQueue
Description

Gets the FrontOffices frontOfficeped to a Queue.

Parametersosid.id.IdqueueId Id of a Queue
Returnosid.tracking.FrontOfficeListlist of frontOffices
ErrorsNOT_FOUND queueId is not found
NULL_ARGUMENT queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.