OSID Logo
OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.AwardEntrySearch
Implementsosid.OsidSearch
Description

The search interface for governing award entry searches.

MethodsearchAmongAwardEntries
Description

Execute this search among the given list of award entries.

Parametersosid.id.IdListawardEntryIdslist of award entry Ids
ErrorsNULL_ARGUMENT awardEntryIds is null
CompliancemandatoryThis method must be implemented.
MethodorderAwardEntryResults
Description

Specify an ordering to the search results.

Parametersosid.course.chronicle.AwardEntrySearchOrderawardEntrySearchOrderaward entry search order
ErrorsNULL_ARGUMENT awardEntrySearchOrder is null
UNSUPPORTED awardEntrySearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAwardEntrySearchRecord
Description

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

Parametersosid.type.TypeawardEntrySearchRecordTypean award entry search record type
Returnosid.course.chronicle.records.AwardEntrySearchRecordthe award entry search record
ErrorsNULL_ARGUMENT awardEntrySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(awardEntrySearchRecordType) is false
CompliancemandatoryThis method must be implemented.