| Interface | osid.recognition.ConferralSearchSession | ||
|---|---|---|---|
| Implements | osid.recognition.ConferralQuerySession | ||
| Used By | osid.recognition.RecognitionManager | ||
osid.recognition.RecognitionProxyManager | |||
| Description |
This session provides methods for searching
getConferralsByQuery() is the basic search method
and returns a list of Academy elements. A more
advanced search may be performed with
getConferralsBySearch(). It accepts a
ConferralSearch in addition to the query for the
purpose of specifying additional options affecting the entire
search, such as ordering. getConferralsBySearch()
returns a ConferralSearchResults that can be used
to access the resulting ConferralList or be used
to perform a search within the result set through
ConferralSearch.
Conferrals may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
| Method | getConferralSearch | ||
| Description |
Gets a conferral search. | ||
| Return | osid.recognition.ConferralSearch | the conferral search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getConferralSearchOrder | ||
| Description |
Gets a conferral search order. The
| ||
| Return | osid.recognition.ConferralSearchOrder | the conferral search order interface | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getConferralsBySearch | ||
| Description |
Gets the search results matching the given search. | ||
| Parameters | osid.recognition.ConferralQuery | conferralQuery | the conferral query |
osid.recognition.ConferralSearch | conferralSearch | the conferral search | |
| Return | osid.recognition.ConferralSearchResults | the conferral search results | |
| Errors | NULL_ARGUMENT | conferralQuery or conferralSearch is
null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | conferralQuery or conferralSearch is not of this
service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getConferralQueryFromInspector | ||
| Description |
Gets a conferral query from an inspector. The
inspector is available from a
| ||
| Parameters | osid.recognition.ConferralQueryInspector | conferralQueryInspector | a conferral query inspector |
| Return | osid.recognition.ConferralQuery | the conferral query | |
| Errors | NULL_ARGUMENT | conferralQueryInspector is null | |
| UNSUPPORTED | conferralQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |