OSID Logo
OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.ConferralSearchSession
Implementsosid.recognition.ConferralQuerySession
Description

This session provides methods for searching Conferral objects. The search query is constructed using the ConferralQuery. The conferral record Type also specifies the record for the conferral query.

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 ConferralQuery. The returns in this session may not be cast directly to these interfaces.

MethodgetConferralSearch
Description

Gets a conferral search.

Returnosid.recognition.ConferralSearchthe conferral search
CompliancemandatoryThis method must be implemented.
MethodgetConferralSearchOrder
Description

Gets a conferral search order. The ConferralSearchOrder is supplied to a ConferralSearch to specify the ordering of results.

Returnosid.recognition.ConferralSearchOrderthe conferral search order interface
CompliancemandatoryThis method must be implemented.
MethodgetConferralsBySearch
Description

Gets the search results matching the given search.

Parametersosid.recognition.ConferralQueryconferralQuerythe conferral query
osid.recognition.ConferralSearchconferralSearchthe conferral search
Returnosid.recognition.ConferralSearchResultsthe conferral search results
ErrorsNULL_ARGUMENT conferralQuery or conferralSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED conferralQuery or conferralSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetConferralQueryFromInspector
Description

Gets a conferral query from an inspector. The inspector is available from a ConferralSearchResults.

Parametersosid.recognition.ConferralQueryInspectorconferralQueryInspectora conferral query inspector
Returnosid.recognition.ConferralQuerythe conferral query
ErrorsNULL_ARGUMENT conferralQueryInspector is null
UNSUPPORTED conferralQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.