Interface | osid.provisioning.rules.QueueConstrainerRuleApplicationSession | ||
---|---|---|---|
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 | canAssignQueueConstrainers | ||
Description |
Tests if this user can alter queue constrainer/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 | assignQueueConstrainerToQueue | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | queueConstrainerId | the Id of the QueueConstrainer |
osid.id.Id | queueId | the Id of the Queue | |
Errors | ALREADY_EXISTS | queueConstrainerId is already applied to queueId
| |
NOT_FOUND | queueConstrainerId or queueId not found | ||
NULL_ARGUMENT | queueConstrainerId or queueId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignQueueConstrainerFromQueue | ||
Description |
Removes a | ||
Parameters | osid.id.Id | queueConstrainerId | the Id of the QueueConstrainer |
osid.id.Id | queueId | the Id of the Queue | |
Errors | NOT_FOUND | queueConstrainerId or queueId not found or
queueConstrainerId not applied to queueId | |
NULL_ARGUMENT | queueConstrainerId or queueId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequenceQueueConstrainers | ||
Description |
Tests if this user can order | ||
Return | boolean | false if QueueConstrainer ordering is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | moveQueueConstrainerAhead | ||
Description |
Reorders queue constrainer for a queue by moving the specified queue constrainer in front of a reference queue constrainer. | ||
Parameters | osid.id.Id | queueConstrainerId | the Id of a QueueConstrainer |
osid.id.Id | queueId | the Id of a Queue | |
osid.id.Id | referenceId | the reference queue constrainer Id | |
Errors | NOT_FOUND | queueConstrainerId, queueId, or referenceId
not found or, queueConstrainerId or referenceId
not related to queueId | |
NULL_ARGUMENT | queueConstrainerId, queueId, or referenceId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | moveQueueConstrainerBehind | ||
Description |
Reorders queue constrainer for a queue by moving the specified queue constrainer behind a reference queue constrainer. | ||
Parameters | osid.id.Id | queueConstrainerId | the Id of a QueueConstrainer |
osid.id.Id | queueId | the Id of a Queue | |
osid.id.Id | referenceId | the reference queue constrainer Id | |
Errors | NOT_FOUND | queueConstrainerId, queueId, or referenceId
not found or, queueConstrainerId or referenceId
not related to queueId | |
NULL_ARGUMENT | queueConstrainerId, queueId, or referenceId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderQueueConstrainers | ||
Description |
Reorders a set of queue constrainers for a queue. | ||
Parameters | osid.id.Id[] | queueConstrainerIds | the Ids for a set of QueueConstrainers |
osid.id.Id | queueId | the Id of a QueueConstrainer | |
Errors | NOT_FOUND | queueId not found or, a queueConstrainerId
not related to queueId | |
NULL_ARGUMENT | queueConstrainerIds or queueId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |