Interface | osid.provisioning.rules.PoolConstrainerQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Pool constrainer may have a query record indicated by
their respective record types. The query record is accessed
via the | ||
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 | canSearchPoolConstrainers | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedDistributorView | ||
Description |
Federates the view for methods in this session. A federated view will include pool constrainer 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 | getPoolConstrainerQuery | ||
Description |
Gets a pool constrainer query. | ||
Return | osid.provisioning.rules.PoolConstrainerQuery | the pool constrainer query | |
Compliance | mandatory | This method must be implemented. | |
Method | getPoolConstrainersByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.provisioning.rules.PoolConstrainerQuery | poolConstrainerQuery | the search query |
Return | osid.provisioning.rules.PoolConstrainerList | the returned PoolConstrainerList | |
Errors | NULL_ARGUMENT | poolConstrainerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | poolConstrainerQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |