Interface | osid.course.chronicle.ProgramEntrySearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing program entry searches. | ||
Method | searchAmongProgramEntries | ||
Description |
Execute this search among the given list of program entries. | ||
Parameters | osid.id.IdList | programEntryIds | list of program entry Ids |
Errors | NULL_ARGUMENT | programEntryIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderProgramEntryResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.course.chronicle.ProgramEntrySearchOrder | programEntrySearchOrder | program entry search order |
Errors | NULL_ARGUMENT | programEntrySearchOrder is null | |
UNSUPPORTED | programEntrySearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramEntrySearchRecord | ||
Description |
Gets the program entry search record corresponding to
the given program entry search record | ||
Parameters | osid.type.Type | programEntrySearchRecordType | a program entry search record type |
Return | osid.course.chronicle.records.ProgramEntrySearchRecord | the program entry search record | |
Errors | NULL_ARGUMENT | programEntrySearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(programEntrySearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |