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