Interface | osid.course.chronicle.ProgramEntryQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
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 | getCourseCatalogId | ||
Description |
Gets the | ||
Return | osid.id.Id | the CourseCatalog Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalog | ||
Description |
Gets the | ||
Return | osid.course.CourseCatalog | the course catalog | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchProgramEntries | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedCourseCatalogView | ||
Description |
Federates the view for methods in this session. A federated view will include program entries in course catalog which are children of this course catalog in the course catalog hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedCourseCatalogView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this course catalog only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getProgramEntryQuery | ||
Description |
Gets a program entry query. | ||
Return | osid.course.chronicle.ProgramEntryQuery | the program entry query | |
Compliance | mandatory | This method must be implemented. | |
Method | getProgramEntriesByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.course.chronicle.ProgramEntryQuery | programEntryQuery | the program entry query |
Return | osid.course.chronicle.ProgramEntryList | the returned ProgramEntryList | |
Errors | NULL_ARGUMENT | programEntryQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | programEntryQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |