Interface | osid.provisioning.rules.QueueProcessorDistributorSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupQueueProcessorDistributorMappings | ||
Description |
Tests if this user can perform lookups of queue
processor/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 | useComparativeQueueProcessorDistributorView | ||
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 | usePlenaryQueueProcessorDistributorView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getQueueProcessorIdsByDistributor | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | distributorId | Id of the Distributor |
Return | osid.id.IdList | list of related queue processor 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 | getQueueProcessorsByDistributor | ||
Description |
Gets the list of queue processors associated with a
| ||
Parameters | osid.id.Id | distributorId | Id of the Distributor |
Return | osid.provisioning.rules.QueueProcessorList | list of related queue processors | |
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 | getQueueProcessorIdsByDistributors | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | distributorIds | list of distributor Ids |
Return | osid.id.IdList | list of queue processor 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 | getQueueProcessorsByDistributors | ||
Description |
Gets the list of queue processor corresponding to a
list of | ||
Parameters | osid.id.IdList | distributorIds | list of distributor Ids |
Return | osid.provisioning.rules.QueueProcessorList | list of queue processors | |
Errors | NULL_ARGUMENT | distributorIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDistributorIdsByQueueProcessor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | queueProcessorId | Id of a QueueProcessor |
Return | osid.id.IdList | list of distributors | |
Errors | NOT_FOUND | queueProcessorId is not found | |
NULL_ARGUMENT | queueProcessorId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDistributorsByQueueProcessor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | queueProcessorId | Id of a QueueProcessor |
Return | osid.provisioning.DistributorList | list of distributors | |
Errors | NOT_FOUND | queueProcessorId is not found | |
NULL_ARGUMENT | queueProcessorId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |