Interface | osid.provisioning.rules.QueueConstrainerEnablerRuleApplicationSession | ||
---|---|---|---|
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 | canAssignQueueConstrainerEnablers | ||
Description |
Tests if this user can alter queue constrainer
enabler/queue constrainer 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 | assignQueueConstrainerEnablerToQueueConstrainer | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | queueConstrainerEnablerId | the Id of the QueueConstrainerEnabler |
osid.id.Id | queueConstrainerId | the Id of the QueueConstrainer | |
Errors | ALREADY_EXISTS | queueConstrainerEnablerId is already applied to
queueConstrainerId | |
NOT_FOUND | queueConstrainerEnablerId or queueConstrainerId
not found | ||
NULL_ARGUMENT | queueConstrainerEnablerId or queueConstrainerId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignQueueConstrainerEnablerFromQueueConstrainer | ||
Description |
Removes a | ||
Parameters | osid.id.Id | queueConstrainerEnablerId | the Id of the QueueConstrainerEnabler |
osid.id.Id | queueConstrainerId | the Id of the QueueConstrainer | |
Errors | NOT_FOUND | queueConstrainerEnablerId or queueConstrainerId
not found or queueConstrainerEnablerId not applied to
queueConstrainerId | |
NULL_ARGUMENT | queueConstrainerEnablerId or queueConstrainerId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequenceQueueConstrainerEnablers | ||
Description |
Tests if this user can order | ||
Return | boolean | false if QueueConstrainerEnabler ordering is
not authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | moveQueueConstrainerEnablerAhead | ||
Description |
Reorders queue constrainer enablers for a queue constrainer by moving the specified queue constrainer enabler in front of a reference queue constrainer enabler. | ||
Parameters | osid.id.Id | queueConstrainerEnablerId | the Id of a QueueConstrainerEnabler |
osid.id.Id | queueConstrainerId | the Id of a QueueConstrainer | |
osid.id.Id | referenceId | the reference queue constrainer enabler Id | |
Errors | NOT_FOUND | queueConstrainerEnablerId, queueConstrainerId, or
referenceId not found or, queueConstrainerEnablerId or
referenceId not related to queueConstrainerId | |
NULL_ARGUMENT | queueConstrainerEnablerId, queueConstrainerId, or
referenceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | moveQueueConstrainerEnablerBehind | ||
Description |
Reorders queue constrainer enablers for a queue constrainer by moving the specified queue constrainer enabler behind a reference queue constrainer enabler. | ||
Parameters | osid.id.Id | queueConstrainerEnablerId | the Id of a QueueConstrainerEnabler |
osid.id.Id | queueConstrainerId | the Id of a QueueConstrainer | |
osid.id.Id | referenceId | the reference queue constrainer enabler Id | |
Errors | NOT_FOUND | queueConstrainerEnablerId, queueConstrainerId, or
referenceId not found or, queueConstrainerEnablerId or
referenceId not related to queueConstrainerId | |
NULL_ARGUMENT | queueConstrainerEnablerId, queueConstrainerId, or
referenceId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderQueueConstrainerEnablers | ||
Description |
Reorders a set of queue constrainer enablers for a queue constrainer. | ||
Parameters | osid.id.Id[] | queueConstrainerEnablerIds | the Ids for a set of QueueConstrainerEnablers |
osid.id.Id | queueConstrainerId | the Id of a QueueConstrainer | |
Errors | NOT_FOUND | queueConstrainerId not found or, a
queueConstrainerEnablerId not related to queueConstrainerId
| |
NULL_ARGUMENT | queueConstrainerEnablerIds or queueConstrainerId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |