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

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

MethodcanAssignQueueProcessorEnablers
Description

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

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

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

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

Adds an existing QueueProcessorEnabler to an FrontFront Office.

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

Removes a QueueProcessorEnabler from an FrontFront Office.

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