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

The search interface for governing program entry searches.

MethodsearchAmongProgramEntries
Description

Execute this search among the given list of program entries.

Parametersosid.id.IdListprogramEntryIdslist of program entry Ids
ErrorsNULL_ARGUMENT programEntryIds is null
CompliancemandatoryThis method must be implemented.
MethodorderProgramEntryResults
Description

Specify an ordering to the search results.

Parametersosid.course.chronicle.ProgramEntrySearchOrderprogramEntrySearchOrderprogram entry search order
ErrorsNULL_ARGUMENT programEntrySearchOrder is null
UNSUPPORTED programEntrySearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetProgramEntrySearchRecord
Description

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