Interface | osid.inquiry.InquirySearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getInquiries | ||
Description |
Gets the inquiry list resulting from a search. | ||
Return | osid.inquiry.InquiryList | the inquiry list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getInquiryQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.inquiry.InquiryQueryInspector | the inquiry query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getInquirySearchResultsRecord | ||
Description |
Gets the inquiry search results record corresponding to
the given inquiry search record | ||
Parameters | osid.type.Type | inquirySearchRecordType | an inquiry search record type |
Return | osid.inquiry.records.InquirySearchResultsRecord | the inquiry search results record | |
Errors | NULL_ARGUMENT | inquirySearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(inquirySearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |