| Interface | osid.recognition.AcademySearchSession | ||
|---|---|---|---|
| Implements | osid.recognition.AcademyQuerySession | ||
| Used By | osid.recognition.RecognitionManager | ||
osid.recognition.RecognitionProxyManager | |||
| Description |
This session provides methods for searching
getAcademiesByQuery() is the basic search method
and returns a list of Academy elements. A more
advanced search may be performed with
getAcademiesBySearch().It accepts an
AcademySearch in addition to the query for the
purpose of specifying additional options affecting the entire
search, such as ordering. getAcademiesBySearch()
returns an AcademySearchResults that can be used
to access the resulting AcademyList or be used to
perform a search within the result set through
AcademySearch.
Academies may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
| Method | getAcademySearch | ||
| Description |
Gets an academy search. | ||
| Return | osid.recognition.AcademySearch | the academy search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAcademySearchOrder | ||
| Description |
Gets an academy search order. The
| ||
| Return | osid.recognition.AcademySearchOrder | the academy search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAcademiesBySearch | ||
| Description |
Gets the search results matching the given search. | ||
| Parameters | osid.recognition.AcademyQuery | academyQuery | the academy query |
osid.recognition.AcademySearch | academySearch | the academy search | |
| Return | osid.recognition.AcademySearchResults | the academy search results | |
| Errors | NULL_ARGUMENT | academyQuery or academies earch is
null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | academyQuery or academies earch is not of this
service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAcademyQueryFromInspector | ||
| Description |
Gets an academy query from an inspector. The inspector
is available from an | ||
| Parameters | osid.recognition.AcademyQueryInspector | academyQueryInspector | an academy query inspector |
| Return | osid.recognition.AcademyQuery | the academy query | |
| Errors | NULL_ARGUMENT | academyQueryInspector is null | |
| UNSUPPORTED | academyQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |