| Interface | osid.provisioning.RequestSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getRequests | ||
| Description |
Gets the request list resulting from a search. | ||
| Return | osid.provisioning.RequestList | the request list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRequestQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.provisioning.RequestQueryInspector | the request query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRequestSearchResultsRecord | ||
| Description |
Gets the request search results record corresponding to
the given request search record | ||
| Parameters | osid.type.Type | requestSearchRecordType | a request search record type |
| Return | osid.provisioning.records.RequestSearchResultsRecord | the request search results record | |
| Errors | NULL_ARGUMENT | requestSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(requestSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |