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

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

MethodcanAssignQueueProcessors
Description

Tests if this user can alter queue processor/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.
MethodcanAssignQueueProcessorsToFrontOffice
Description

Tests if this user can alter queue processor/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 processor 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.
MethodgetAssignableFrontOfficeIdsForQueueProcessor
Description

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

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

Adds an existing QueueProcessor to an FrontFront Office.

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

Removes a QueueProcessor from an FrontFront Office.

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