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

This session provides methods to re-assign QueueConstrainer to FrontOffice mappings. a QueueConstrainer may appear in multiple FrontOffice objects and removing the last reference to a QueueConstrainer 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 QueueConstrainer to another FrontOffice is not a copy operation (eg: does not change its Id ).

MethodcanAssignQueueConstrainers
Description

Tests if this user can alter queue constrainer/office mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignQueueConstrainersToFrontOffice
Description

Tests if this user can alter queue constrainer/office mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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.

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 office including and under the given front office node in which any queue constrainer 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.
MethodgetAssignableFrontOfficeIdsForQueueConstrainer
Description

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

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

Adds an existing QueueConstrainer to an FrontFront Office.

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

Removes a QueueConstrainer from an FrontFront Office.

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