Interface | osid.provisioning.PoolSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getPools | ||
Description |
Gets the pool list resulting from a search. | ||
Return | osid.provisioning.PoolList | the pool list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getPoolQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.provisioning.PoolQueryInspector | the pool query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getPoolSearchResultsRecord | ||
Description |
Gets the pool search results record corresponding to
the given pool search record | ||
Parameters | osid.type.Type | poolSearchRecordType | a pool search record type |
Return | osid.provisioning.records.PoolSearchResultsRecord | the pool search results 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. |