Interface | osid.course.requisite.RequisiteQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Requisites 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 | canSearchRequisites | ||
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 requisites 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 | useSequesteredRequisiteView | ||
Description |
The returns from the search methods omit sequestered requisites. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useUnsequesteredRequisiteView | ||
Description |
All requisites are returned including sequestered requisites. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRequisiteQuery | ||
Description |
Gets a requisite query. | ||
Return | osid.course.requisite.RequisiteQuery | the requisite query | |
Compliance | mandatory | This method must be implemented. | |
Method | getRequisitesByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.course.requisite.RequisiteQuery | requisiteQuery | the requisite query |
Return | osid.course.requisite.RequisiteList | the returned RequisiteList | |
Errors | NULL_ARGUMENT | requisiteQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | requisiteQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |