OSID Logo
OSID Specifications
course chronicle package
Version 3.0.0
Interfaceosid.course.chronicle.ProgramEntrySearch
Implementsosid.OsidSearch
Used Byosid.course.chronicle.ProgramEntrySearchSession
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_ARGUMENTprogramEntryIds is null
CompliancemandatoryThis method must be implemented.
MethodorderProgramEntryResults
Description

Specify an ordering to the search results.

Parametersosid.course.chronicle.ProgramEntrySearchOrderprogramEntrySearchOrderprogram entry search order
ErrorsNULL_ARGUMENTprogramEntrySearchOrder is null
UNSUPPORTEDprogramEntrySearchOrder 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_ARGUMENTprogramEntrySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(programEntrySearchRecordType) is false
CompliancemandatoryThis method must be implemented.