| Interface | osid.provisioning.PoolSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing pool searches. | ||
| Method | searchAmongPools | ||
| Description |
Execute this search among the given list of pools. | ||
| Parameters | osid.id.IdList | poolIds | list of pools |
| Errors | NULL_ARGUMENT | poolIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderPoolResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.provisioning.PoolSearchOrder | poolSearchOrder | pool search order |
| Errors | NULL_ARGUMENT | poolSearchOrder is null | |
| UNSUPPORTED | poolSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getPoolSearchRecord | ||
| Description |
Gets the pool search record corresponding to the given
pool search record | ||
| Parameters | osid.type.Type | poolSearchRecordType | a pool search record type |
| Return | osid.provisioning.records.PoolSearchRecord | the pool search record | |
| Errors | NULL_ARGUMENT | poolSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(poolSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |