Interface | osid.provisioning.ProvisionableDistributorSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupProvisionableDistributorProvisionables | ||
Description |
Tests if this user can perform lookups of
provisionable/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 provisionables is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeProvisionableDistributorView | ||
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 | usePlenaryProvisionableDistributorView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getProvisionableIdsByDistributor | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | distributorId | Id of the Distributor |
Return | osid.id.IdList | list of related provisionable 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 | getProvisionablesByDistributor | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | distributorId | Id of the Distributor |
Return | osid.provisioning.ProvisionableList | list of related provisionables | |
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 | getProvisionableIdsByDistributors | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | distributorIds | list of distributor Ids |
Return | osid.id.IdList | list of provisionable 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 | getProvisionablesByDistributors | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | distributorIds | list of distributor Ids |
Return | osid.provisioning.ProvisionableList | list of provisionables | |
Errors | NULL_ARGUMENT | distributorIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDistributorIdsByProvisionable | ||
Description |
Gets the | ||
Parameters | osid.id.Id | provisionableId | Id of a Provisionable |
Return | osid.id.IdList | list of distributors | |
Errors | NOT_FOUND | provisionableId is not found | |
NULL_ARGUMENT | provisionableId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getDistributorsByProvisionable | ||
Description |
Gets the | ||
Parameters | osid.id.Id | provisionableId | Id of a Provisionable |
Return | osid.provisioning.DistributorList | list of distributors | |
Errors | NOT_FOUND | provisionableId is not found | |
NULL_ARGUMENT | provisionableId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |