Interface | osid.provisioning.PoolDistributorSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupPoolDistributorMappings | ||
Description |
Tests if this user can perform lookups of
pool/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 | useComparativePoolDistributorView | ||
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 | usePlenaryPoolDistributorView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getPoolIdsByDistributor | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | distributorId | Id of the Distributor |
Return | osid.id.IdList | list of related pool 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 | getPoolsByDistributor | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | distributorId | Id of the Distributor |
Return | osid.provisioning.PoolList | list of related pools | |
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 | getPoolIdsByDistributors | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | distributorIds | list of distributor Ids |
Return | osid.id.IdList | list of pool 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 | getPoolsByDistributors | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | distributorIds | list of distributor Ids |
Return | osid.provisioning.PoolList | list of pools | |
Errors | NULL_ARGUMENT | distributorIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDistributorIdsByPool | ||
Description |
Gets the | ||
Parameters | osid.id.Id | poolId | Id of a Pool |
Return | osid.id.IdList | list of distributors | |
Errors | NOT_FOUND | poolId is not found | |
NULL_ARGUMENT | poolId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDistributorsByPool | ||
Description |
Gets the | ||
Parameters | osid.id.Id | poolId | Id of a Pool |
Return | osid.provisioning.DistributorList | list of distributors | |
Errors | NOT_FOUND | poolId is not found | |
NULL_ARGUMENT | poolId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |