| Interface | osid.provisioning.rules.PoolEnablerSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Used By | osid.provisioning.rules.PoolEnablerSearchSession | ||
| Description |
The search interface for governing pool enabler searches. | ||
| Method | searchAmongPoolEnablers | ||
| Description |
Execute this search among the given list of pool enablers. | ||
| Parameters | osid.id.IdList | poolEnablerIds | list of pool enablers |
| Errors | NULL_ARGUMENT | poolEnablerIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderPoolEnablerResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.provisioning.rules.PoolEnablerSearchOrder | poolEnablerSearchOrder | pool enabler search order |
| Errors | NULL_ARGUMENT | poolEnablerSearchOrder is null | |
| UNSUPPORTED | poolEnablerSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getPoolEnablerSearchRecord | ||
| Description |
Gets the pool enabler search record corresponding to
the given pool enabler search record | ||
| Parameters | osid.type.Type | poolEnablerSearchRecordType | a pool enabler search record type |
| Return | osid.provisioning.rules.records.PoolEnablerSearchRecord | the pool enabler search record | |
| Errors | NULL_ARGUMENT | poolEnablerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(poolEnablerSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |