OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
recognition package
Version 3.0.0
Release Candidate Preview
| Interface | osid.recognition.ConvocationSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getConvocations | ||
| Description |
Gets the convocation list resulting from a search. | ||
| Return | osid.recognition.ConvocationList | the convocation list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getConvocationQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terns used in the search. | ||
| Return | osid.recognition.ConvocationQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getConvocationSearchResultsRecord | ||
| Description |
Gets the convocation search results record
corresponding to the given convocation search record
| ||
| Parameters | osid.type.Type | convocationSearchRecordType | a convocation search record type |
| Return | osid.recognition.records.ConvocationSearchResultsRecord | the convocation search record | |
| Errors | NULL_ARGUMENT | convocationSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(convocationSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |