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

This session defines methods for resourcing queues. A more detailed assignment service can be managed through the Resourcing OSID.

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 front office
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanResourceQueues
Description

Tests if this user can assign Resources to queues. 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 not offer assignment operations to unauthorized users.

Returnboolean false if resource assignment methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanResourceQueue
Description

Tests if this user can assign Resources to a queue. 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 not offer assignment operations to unauthorized users.

Parametersosid.id.IdqueueIdthe Id of a Queue
Returnboolean false if resource assignment methods are not authorized, true otherwise
ErrorsNULL_ARGUMENT queueId is null
CompliancemandatoryThis method must be implemented.
MethodgetResources
Description

Gets a list of resource assigned in a queue.

Parametersosid.id.IdqueueIdthe Id of a Queue
Returnosid.resource.ResourceLista list of resources
ErrorsNOT_FOUND queueId is not found
NULL_ARGUMENT queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodassignResource
Description

Assigns a Resource to a queue.

Parametersosid.id.IdqueueIdthe Id of a Queue
osid.id.IdresourceIdthe Id of the Resource
ErrorsALREADY_EXISTS resourceId already assigned to this queue
NOT_FOUND queueId or resourceId not found
NULL_ARGUMENT queueId or resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignResource
Description

Unassigns a Resource from this queue.

Parametersosid.id.IdqueueIdthe Id of a Queue
osid.id.IdresourceIdthe Id of the Resource
ErrorsNOT_FOUND queueId not found or resourceId not assigned to this queue
NULL_ARGUMENT queueId or resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.