| Interface | osid.tracking.rules.QueueEnablerFrontOfficeAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.tracking.rules.TrackingRulesManager | ||
osid.tracking.rules.TrackingRulesProxyManager | |||
| Description |
This session provides methods to re-assign
Adding a reference of a | ||
| Method | canAssignQueueEnablers | ||
| 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
| ||
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignQueueEnablerToFrontOffice | ||
| 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
| ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Errors | NULL_ARGUMENT | frontOfficeId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableFrontOfficeIds | ||
| Description |
Gets a list of front offices including and under the given front office node in which any queue enabler can be assigned. | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.id.IdList | list of assignable front office Ids | |
| Errors | NULL_ARGUMENT | frontOfficeId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableFrontOfficeIdsForQueueEnabler | ||
| Description |
Gets a list of front offices including and under the given front office node in which a specific queue enabler can be assigned. | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
osid.id.Id | queueEnablerId | the Id of the QueueEnabler | |
| Return | osid.id.IdList | list of assignable front office Ids | |
| Errors | NULL_ARGUMENT | frontOfficeId or queueEnablerId is
null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignQueueEnablerToFrontOffice | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | queueEnablerId | the Id of the QueueEnabler |
osid.id.Id | frontOfficeId | the Id of the FrontOffice | |
| Errors | ALREADY_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 | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignQueueEnablerFromFrontOffice | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | queueEnablerId | the Id of the QueueEnabler |
osid.id.Id | frontOfficeId | the Id of the FrontOffice | |
| Errors | NOT_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 | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignQueueEnablerToFrontOffice | ||
| Description |
Moves a | ||
| Parameters | osid.id.Id | queueEnablerId | the Id of the QueueEnabler |
osid.id.Id | fromFrontOfficeId | the Id of the current FrontOffice | |
osid.id.Id | toFrontOfficeId | the Id of the destination FrontOffice | |
| Errors | ALREADY_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 | ||
| Compliance | mandatory | This method must be implemented. | |