Interface | osid.provisioning.rules.QueueConstrainerEnablerRuleLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
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 | canLookupQueueConstrainerEnablerRules | ||
Description |
Tests if this user can perform lookups of queue
constrainer enabler/queue constrainer mappings. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known lookup methods
in this session will result in a | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeQueueConstrainerEnablerRuleView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryQueueConstrainerEnablerRuleView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedDistributorView | ||
Description |
Federates the view for methods in this session. A federated view will include queue constrainer enablers in distributors which are children of this distributor in the distributor hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedDistributorView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this distributor only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getQueueConstrainerEnablerIdsForQueueConstrainer | ||
Description |
Gets the | ||
Parameters | osid.id.Id | queueConstrainerId | Id of the QueueConstrainer |
Return | osid.id.IdList | the queue constrainer enabler Ids | |
Errors | NOT_FOUND | queueConstrainerId is not found | |
NULL_ARGUMENT | queueConstrainerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueConstrainerEnablersForQueueConstrainer | ||
Description |
Gets the | ||
Parameters | osid.id.Id | queueConstrainerId | Id of the QueueConstrainer |
Return | osid.provisioning.rules.QueueConstrainerEnablerList | the queue constrainer enablers | |
Errors | NOT_FOUND | queueConstrainerId is not found | |
NULL_ARGUMENT | queueConstrainerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueConstrainerIdsForQueueConstrainerEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | queueConstrainerEnablerId | Id of a QueueConstrainerEnabler |
Return | osid.id.IdList | list of queue constrainer Ids | |
Errors | NOT_FOUND | queueConstrainerEnablerId is not found | |
NULL_ARGUMENT | queueConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueConstrainersForQueueConstrainerEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | queueConstrainerEnablerId | Id of a QueueConstrainerEnabler |
Return | osid.provisioning.rules.QueueConstrainerList | list of queue constrainers | |
Errors | NOT_FOUND | queueConstrainerEnablerId is not found | |
NULL_ARGUMENT | queueConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |