Interface | osid.provisioning.rules.QueueProcessorRuleApplicationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to apply | ||
Method | getDistributorId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Distributor Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getDistributor | ||
Description |
Gets the | ||
Return | osid.provisioning.Distributor | the distributor | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canAssignQueueProcessors | ||
Description |
Tests if this user can alter queue processor/queue
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 | assignQueueProcessorToQueue | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | queueProcessorId | the Id of the QueueProcessor |
osid.id.Id | queueId | the Id of the Queue | |
Errors | ALREADY_EXISTS | queueProcessorId is already applied to queueId
| |
NOT_FOUND | queueProcessorId or queueId not found | ||
NULL_ARGUMENT | queueProcessorId or queueId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignQueueProcessorFromQueue | ||
Description |
Removes a | ||
Parameters | osid.id.Id | queueProcessorId | the Id of the QueueProcessor |
osid.id.Id | queueId | the Id of the Queue | |
Errors | NOT_FOUND | queueProcessorId or queueId not found or
queueProcessorId not applied to queueId | |
NULL_ARGUMENT | queueProcessorId or queueId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequenceQueueProcessors | ||
Description |
Tests if this user can order | ||
Return | boolean | false if QueueProcessor ordering is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | moveQueueProcessorAhead | ||
Description |
Reorders queue processors for a queue by moving the specified queue processor in front of a reference queue processor. | ||
Parameters | osid.id.Id | queueProcessorId | the Id of a QueueProcessor |
osid.id.Id | queueId | the Id of a Queue | |
osid.id.Id | referenceId | the reference queue processor Id | |
Errors | NOT_FOUND | queueProcessorId, queueId, or referenceId not
found or, queueProcessorId or referenceId not
related to queueId | |
NULL_ARGUMENT | queueProcessorId, queueId, or referenceId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | moveQueueProcessorBehind | ||
Description |
Reorders queue processors for a queue by moving the specified queue processor behind a reference queue processor. | ||
Parameters | osid.id.Id | queueProcessorId | the Id of a QueueProcessor |
osid.id.Id | queueId | the Id of a Queue | |
osid.id.Id | referenceId | the reference queue processor Id | |
Errors | NOT_FOUND | queueProcessorId, queueId, or referenceId not
found or, queueProcessorId or referenceId not
related to queueId | |
NULL_ARGUMENT | queueProcessorId, queueId, or referenceId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderQueueProcessors | ||
Description |
Reorders a set of queue processors for a queue. | ||
Parameters | osid.id.Id[] | queueProcessorIds | the Ids for a set of QueueProcessors |
osid.id.Id | queueId | the Id of a QueueProcessor | |
Errors | NOT_FOUND | queueId not found or, a queueProcessorId not
related to queueId | |
NULL_ARGUMENT | queueProcessorIds or queueId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |