OSID Logo
OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.AwardEntrySearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetAwardEntries
Description

Gets the course list resulting from a search.

Returnosid.course.chronicle.AwardEntryListthe award entry list
ErrorsILLEGAL_STATEthe award entry list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetAwardEntryQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.course.chronicle.AwardEntryQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetAwardEntrySearchResultsRecord
Description

Gets the award entry search results 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.AwardEntrySearchResultsRecordthe award entry search results record
ErrorsNULL_ARGUMENT awardEntrySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(awardEntrySearchRecordType) is false
CompliancemandatoryThis method must be implemented.