OSID Logo
OSID Specifications
tracking rules package
Version 3.0.0
Interfaceosid.tracking.rules.QueueConstrainerEnablerFrontOfficeAssignmentSession
Implementsosid.OsidSession
Used Byosid.tracking.rules.TrackingRulesManager
osid.tracking.rules.TrackingRulesProxyManager
Description

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

MethodcanAssignQueueConstrainerEnablers
Description

Tests if this user can alter queue constrainer 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.

Returnbooleanfalse if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignQueueConstrainerEnablersToFrontOffice
Description

Tests if this user can alter queue constrainer 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
Returnbooleanfalse if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENTfrontOfficeId 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 enabler can be assigned.

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

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

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
osid.id.IdqueueConstrainerEnablerIdthe Id of the QueueConstrainerEnabler
Returnosid.id.IdListlist of assignable front office Ids
ErrorsNULL_ARGUMENTfrontOfficeId or queueConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignQueueConstrainerEnablerToFrontOffice
Description

Adds an existing QueueConstrainerEnabler to a FrontFront Office .

Parametersosid.id.IdqueueConstrainerEnablerIdthe Id of the QueueConstrainerEnabler
osid.id.IdfrontOfficeIdthe Id of the FrontOffice
ErrorsALREADY_EXISTSqueueConstrainerEnablerId is already assigned to frontOfficeId
NOT_FOUNDqueueConstrainerEnablerId or frontOfficeId not found
NULL_ARGUMENTqueueConstrainerEnablerId or frontOfficeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignQueueConstrainerEnablerFromFrontOffice
Description

Removes a QueueConstrainerEnabler from a FrontFront Office .

Parametersosid.id.IdqueueConstrainerEnablerIdthe Id of the QueueConstrainerEnabler
osid.id.IdfrontOfficeIdthe Id of the FrontOffice
ErrorsNOT_FOUNDqueueConstrainerEnablerId or frontOfficeId not found or queueConstrainerEnablerId not assigned to frontOfficeId
NULL_ARGUMENTqueueConstrainerEnablerId or frontOfficeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignQueueConstrainerEnablerToFrontOffice
Description

Moves a QueueConstrainerEnabler from one FrontOffice to another. Mappings to other FrontOffices are unaffected.

Parametersosid.id.IdqueueConstrainerEnablerIdthe Id of the QueueConstrainerEnabler
osid.id.IdfromFrontOfficeIdthe Id of the current FrontOffice
osid.id.IdtoFrontOfficeIdthe Id of the destination FrontOffice
ErrorsALREADY_EXISTSqueueConstrainerEnablerId already assigned to toFrontOfficeId
NOT_FOUNDqueueConstrainerEnablerId, fromFrontOfficeId , or toFrontOfficeId not found or queueConstrainerEnablerId not mapped to fromFrontOfficeId
NULL_ARGUMENTqueueConstrainerEnablerId, fromFrontOfficeId , or toFrontOfficeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.