| Interface | osid.provisioning.rules.PoolEnablerSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.provisioning.rules.PoolEnablerSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getPoolEnablers | ||
| Description |
Gets the pool enabler list resulting from a search. | ||
| Return | osid.provisioning.rules.PoolEnablerList | the pool enabler list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPoolEnablerQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.provisioning.rules.PoolEnablerQueryInspector | the pool enabler query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPoolEnablerSearchResultsRecord | ||
| Description |
Gets the pool enabler search results 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.PoolEnablerSearchResultsRecord | the pool enabler search results 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. | |