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

The search interface for governing award searches.

MethodsearchAmongAwards
Description

Execute this search among the given list of awards.

Parametersosid.id.IdListawardIdslist of awards
ErrorsNULL_ARGUMENT awardIds is null
CompliancemandatoryThis method must be implemented.
MethodorderAwardResults
Description

Specify an ordering to the search results.

Parametersosid.recognition.AwardSearchOrderawardSearchOrderaward search order
ErrorsNULL_ARGUMENT awardSearchOrder is null
UNSUPPORTED awardSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAwardSearchRecord
Description

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

Parametersosid.type.TypeawardSearchRecordTypean award search record type
Returnosid.recognition.records.AwardSearchRecordthe award search record
ErrorsNULL_ARGUMENT awardSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(awardSearchRecordType) is false
CompliancemandatoryThis method must be implemented.