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

This session provides methods to re-assign Queues to FrontOffice objects. A Queue may appear in multiple FrontOffice objects and removing the last reference to a Queue is the equivalent of deleting it. Each FrontOffice may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Queue to another FrontOffice is not a copy operation (eg: does not change its Id ).

MethodcanAssignQueues
Description

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

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignQueuesToFrontOffice
Description

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

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT frontOfficeId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableFrontOfficeIds
Description

Gets a list of front offices including and under the given front office node in which any queue can be assigned.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.id.IdListlist of assignable front office Ids
ErrorsNULL_ARGUMENT frontOfficeId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableFrontOfficeIdsForQueue
Description

Gets a list of front offices including and under the given front office node in which a specific queue can be assigned.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
osid.id.IdqueueIdthe Id of the Queue
Returnosid.id.IdListlist of assignable front office Ids
ErrorsNULL_ARGUMENT frontOfficeId or queueId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignQueueToFrontOffice
Description

Adds an existing Queue to a FrontOffice.

Parametersosid.id.IdqueueIdthe Id of the Queue
osid.id.IdfrontOfficeIdthe Id of the FrontOffice
ErrorsALREADY_EXISTS queueId is already assigned to frontOfficeId
NOT_FOUND queueId or frontOfficeId not found
NULL_ARGUMENT queueId or frontOfficeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignQueueFromFrontOffice
Description

Removes a Queue from a FrontOffice.

Parametersosid.id.IdqueueIdthe Id of the Queue
osid.id.IdfrontOfficeIdthe Id of the FrontOffice
ErrorsNOT_FOUND queueId or frontOfficeId not found or queueId not assigned to frontOfficeId
NULL_ARGUMENT queueId or frontOfficeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.