Interface | osid.course.chronicle.ProgramEntrySearchSession | ||
---|---|---|---|
Implements | osid.course.chronicle.ProgramEntryQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
ProgramEntries may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getProgramEntrySearch | ||
Description |
Gets a program entry search. | ||
Return | osid.course.chronicle.ProgramEntrySearch | the program entry search | |
Compliance | mandatory | This method must be implemented. | |
Method | getProgramEntrySearchOrder | ||
Description |
Gets a program entry search order. The | ||
Return | osid.course.chronicle.ProgramEntrySearchOrder | the program entry search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getProgramEntriesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.course.chronicle.ProgramEntryQuery | programEntryQuery | the program entry query |
osid.course.chronicle.ProgramEntrySearch | programEntrySearch | the program entry search | |
Return | osid.course.chronicle.ProgramEntrySearchResults | the program entry search results | |
Errors | NULL_ARGUMENT | programEntryQuery or programEntrySearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | programEntryQuery or ProgramEntrySearch is
not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramEntryQueryFromInspector | ||
Description |
Gets a program entry query from an inspector. The
inspector is available from a | ||
Parameters | osid.course.chronicle.ProgramEntryQueryInspector | programEntryQueryInspector | a program entry query inspector |
Return | osid.course.chronicle.ProgramEntryQuery | the program entry query | |
Errors | NULL_ARGUMENT | programEntryQueryInspector is null | |
UNSUPPORTED | programEntryQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |