OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
recognition package
Version 3.0.0
Release Candidate Preview
| Interface | osid.recognition.AcademySearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getAcademies | ||
| Description |
Gets the academy list resulting from a search. | ||
| Return | osid.recognition.AcademyList | the academy list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAcademyQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terns used in the search. | ||
| Return | osid.recognition.AcademyQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAcademySearchResultsRecord | ||
| Description |
Gets the academy search rsults record corresponding to the given academy search record Type. This method is used to retrieve an object implementing the requested record. | ||
| Parameters | osid.type.Type | academySearchRecordType | an academy search record type |
| Return | osid.recognition.records.AcademySearchResultsRecord | the academy search results record | |
| Errors | NULL_ARGUMENT | academySearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(academySearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |