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

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

MethodcanAssignQueueEnablers
Description

Tests if this user can alter queue enabler/front 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. T his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodcanAssignQueueEnablerToFrontOffice
Description

Tests if this user can alter queue enabler/front 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. T his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Parametersosid.id.IdfrontOfficeId the Id of the FrontOffice
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT frontOfficeId is null
Compliancemandatory This method must be implemented.
MethodgetAssignableFrontOfficeIds
Description

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

Parametersosid.id.IdfrontOfficeId the Id of the FrontOffice
Returnosid.id.IdList list of assignable front office Ids
ErrorsNULL_ARGUMENT frontOfficeId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAssignableFrontOfficeIdsForQueueEnabler
Description

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

Parametersosid.id.IdfrontOfficeId the Id of the FrontOffice
osid.id.IdqueueEnablerId the Id of the QueueEnabler
Returnosid.id.IdList list of assignable front office Ids
ErrorsNULL_ARGUMENT frontOfficeId or queueEnablerId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignQueueEnablerToFrontOffice
Description

Adds an existing QueueEnabler to a FrontOffice.

Parametersosid.id.IdqueueEnablerId the Id of the QueueEnabler
osid.id.IdfrontOfficeId the Id of the FrontOffice
ErrorsALREADY_EXISTS queueEnablerId is already assigned to frontOfficeId
NOT_FOUND queueEnablerId or frontOfficeId not found
NULL_ARGUMENT queueEnablerId or frontOfficeId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignQueueEnablerFromFrontOffice
Description

Removes a QueueEnabler from a FrontOffice.

Parametersosid.id.IdqueueEnablerId the Id of the QueueEnabler
osid.id.IdfrontOfficeId the Id of the FrontOffice
ErrorsNOT_FOUND queueEnablerId or frontOfficeId not found or queueEnablerId not assigned to frontOfficeId
NULL_ARGUMENT queueEnablerId or frontOfficeId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignQueueEnablerToFrontOffice
Description

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

Parametersosid.id.IdqueueEnablerId the Id of the QueueEnabler
osid.id.IdfromFrontOfficeId the Id of the current FrontOffice
osid.id.IdtoFrontOfficeId the Id of the destination FrontOffice
ErrorsALREADY_EXISTS queueEnablerId already assigned to toFrontOfficeId
NOT_FOUND queueEnablerId, fromFrontOfficeId, or toFrontOfficeId not found or queueEnablerId not mapped to fromFrontOfficeId
NULL_ARGUMENT queueEnablerId, fromFrontOfficeId, or toFrontOfficeId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.