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

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

MethodgetProgramEntries
Description

Gets the course list resulting from a search.

Returnosid.course.chronicle.ProgramEntryListthe program entry list
ErrorsILLEGAL_STATEthe program entry list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetProgramEntryQueryInspector
Description

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

Returnosid.course.chronicle.ProgramEntryQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetProgramEntrySearchResultsRecord
Description

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

Parametersosid.type.TypeprogramEntrySearchRecordTypea program entry search record type
Returnosid.course.chronicle.records.ProgramEntrySearchResultsRecordthe program entry search results record
ErrorsNULL_ARGUMENT programEntrySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(programEntrySearchRecordType) is false
CompliancemandatoryThis method must be implemented.