OSID Logo
OSID Specifications
recognition package
Version 3.1.0
Interfaceosid.recognition.AwardSearch
Implementsosid.OsidSearch
Used Byosid.recognition.AwardSearchSession
Description

The search interface for governing award searches.

MethodsearchAmongAwards
Description

Execute this search among the given list of awards.

Parametersosid.id.IdListawardIds list of awards
ErrorsNULL_ARGUMENT awardIds is null
Compliancemandatory This method must be implemented.
MethodorderAwardResults
Description

Specify an ordering to the search results.

Parametersosid.recognition.AwardSearchOrderawardSearchOrder award search order
ErrorsNULL_ARGUMENT awardSearchOrder is null
UNSUPPORTED awardSearchOrder is not of this service
Compliancemandatory This 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.TypeawardSearchRecordType an award search record type
Returnosid.recognition.records.AwardSearchRecord the award search record
ErrorsNULL_ARGUMENT awardSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(awardSearchRecordType) is false
Compliancemandatory This method must be implemented.