OSID Logo
OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.ConferralSearch
Implementsosid.OsidSearch
Description

The search interface for governing conferral searches.

MethodsearchAmongConferrals
Description

Execute this search among the given list of conferrals.

Parametersosid.id.IdListconferralIdslist of conferrals
ErrorsNULL_ARGUMENT conferralIds is null
CompliancemandatoryThis method must be implemented.
MethodorderConferralResults
Description

Specify an ordering to the search results.

Parametersosid.recognition.ConferralSearchOrderconferralSearchOrderconferral search order
ErrorsNULL_ARGUMENT conferralSearchOrder is null
UNSUPPORTED conferralSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetConferralSearchRecord
Description

Gets the conferral search record corresponding to the given conferral search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypeconferralSearchRecordTypea conferral search record type
Returnosid.recognition.records.ConferralSearchRecordthe conferral search record
ErrorsNULL_ARGUMENT conferralSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(conferralSearchRecordType) is false
CompliancemandatoryThis method must be implemented.