Interface | osid.provisioning.rules.QueueConstrainerEnablerDistributorSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupQueueConstrainerEnablerDistributorMappings | ||
Description |
Tests if this user can perform lookups of queue
constrainer enabler/distributor 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 | useComparativeQueueConstrainerEnablerDistributorView | ||
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 | usePlenaryQueueConstrainerEnablerDistributorView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getQueueConstrainerEnablerIdsByDistributor | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | distributorId | Id of the Distributor |
Return | osid.id.IdList | list of related queue constrainer enabler Ids | |
Errors | NOT_FOUND | distributorId is not found | |
NULL_ARGUMENT | distributorId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueConstrainerEnablersByDistributor | ||
Description |
Gets the list of queue constrainer enablers associated
with a | ||
Parameters | osid.id.Id | distributorId | Id of the Distributor |
Return | osid.provisioning.rules.QueueConstrainerEnablerList | list of related queue constrainer enablers | |
Errors | NOT_FOUND | distributorId is not found | |
NULL_ARGUMENT | distributorId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueConstrainerEnablerIdsByDistributors | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | distributorIds | list of distributor Ids |
Return | osid.id.IdList | list of queue constrainer enabler Ids | |
Errors | NULL_ARGUMENT | distributorIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueConstrainerEnablersByDistributors | ||
Description |
Gets the list of queue constrainer enablers
corresponding to a list of | ||
Parameters | osid.id.IdList | distributorIds | list of distributor Ids |
Return | osid.provisioning.rules.QueueConstrainerEnablerList | list of queue constrainer enablers | |
Errors | NULL_ARGUMENT | distributorIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDistributorIdsByQueueConstrainerEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | queueConstrainerEnablerId | Id of a QueueConstrainerEnabler |
Return | osid.id.IdList | list of distributors | |
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 | getDistributorsByQueueConstrainerEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | queueConstrainerEnablerId | Id of a QueueConstrainerEnabler |
Return | osid.provisioning.DistributorList | list of distributors | |
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. |