Interface | osid.provisioning.PoolLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most
applications as it permits operation even if there is data
that cannot be accessed. The methods | ||
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 | canLookupPools | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativePoolView | ||
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 | usePlenaryPoolView | ||
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 pools in distributors which are children of this broker 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 | useActivePoolView | ||
Description |
Only active pools are returned from methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusPoolView | ||
Description |
Borth active and inactive pools are returned from methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getPool | ||
Description |
Gets the In active mode, pools are returned that are currently active. In any status mode, active and inactive pool are returned. | ||
Parameters | osid.id.Id | poolId | Id of the Pool |
Return | osid.provisioning.Pool | the pool | |
Errors | NOT_FOUND | poolId not found | |
NULL_ARGUMENT | poolId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getPoolsByIds | ||
Description |
Gets a In active mode, pools are returned that are currently active. In any status mode, active and inactive pool are returned. | ||
Parameters | osid.id.IdList | poolIds | the list of Ids to retrieve |
Return | osid.provisioning.PoolList | the returned Pool list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | poolIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPoolsByGenusType | ||
Description |
Gets a In active mode, pools are returned that are currently active. In any status mode, active and inactive pool are returned. | ||
Parameters | osid.type.Type | poolGenusType | a pool genus type |
Return | osid.provisioning.PoolList | the returned Pool list | |
Errors | NULL_ARGUMENT | poolGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPoolsByParentGenusType | ||
Description |
Gets a In active mode, pools are returned that are currently active. In any status mode, active and inactive pool are returned. | ||
Parameters | osid.type.Type | poolGenusType | a pool genus type |
Return | osid.provisioning.PoolList | the returned Pool list | |
Errors | NULL_ARGUMENT | poolGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPoolsByRecordType | ||
Description |
Gets a In active mode, pools are returned that are currently active. In any status mode, active and inactive pool are returned. | ||
Parameters | osid.type.Type | poolRecordType | a pool record type |
Return | osid.provisioning.PoolList | the returned Pool list | |
Errors | NULL_ARGUMENT | poolRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPoolsForBroker | ||
Description |
Gets a In active mode, pools are returned that are currently active. In any status mode, active and inactive pool are returned. | ||
Parameters | osid.id.Id | brokerId | a broker Id |
Return | osid.provisioning.PoolList | the returned Pool list | |
Errors | NULL_ARGUMENT | brokerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPoolsByProvider | ||
Description |
Gets a In active mode, pools are returned that are currently active. In any status mode, active and inactive pool are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.provisioning.PoolList | the returned Pool list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPools | ||
Description |
Gets all In plenary mode, the returned list contains all known pools or an error results. Otherwise, the returned list may contain only those pools that are accessible through this session. In active mode, pools are returned that are currently active. In any status mode, active and inactive pool are returned. | ||
Return | osid.provisioning.PoolList | a list of Pools | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |