OSID Logo
OSID Specifications
course chronicle package
Version 3.1.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.IdListprogramEntryIds list of program entry Ids
ErrorsNULL_ARGUMENT programEntryIds is null
Compliancemandatory This method must be implemented.
MethodorderProgramEntryResults
Description

Specify an ordering to the search results.

Parametersosid.course.chronicle.ProgramEntrySearchOrderprogramEntrySearchOrder program entry search order
ErrorsNULL_ARGUMENT programEntrySearchOrder is null
UNSUPPORTED programEntrySearchOrder is not of this service
Compliancemandatory This 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.TypeprogramEntrySearchRecordType a program entry search record type
Returnosid.course.chronicle.records.ProgramEntrySearchRecord the program entry search record
ErrorsNULL_ARGUMENT programEntrySearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(programEntrySearchRecordType) is false
Compliancemandatory This method must be implemented.