Interface | osid.course.program.EnrollmentSearchSession | ||
---|---|---|---|
Implements | osid.course.program.EnrollmentQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Enrollments may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getEnrollmentSearch | ||
Description |
Gets an enrollment search. | ||
Return | osid.course.program.EnrollmentSearch | the enrollment search | |
Compliance | mandatory | This method must be implemented. | |
Method | getEnrollmentSearchOrder | ||
Description |
Gets an enrollment search order. The | ||
Return | osid.course.program.EnrollmentSearchOrder | the enrollment search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getEnrollmentsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.course.program.EnrollmentQuery | enrollmentQuery | the enrollment query |
osid.course.program.EnrollmentSearch | enrollmentSearch | the enrollment search | |
Return | osid.course.program.EnrollmentSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | enrollmentQuery or enrollmentSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | enrollmentQuery or enrollmentSearch is not of
this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEnrollmentQueryFromInspector | ||
Description |
Gets an enrollment query from an inspector. The
inspector is available from an | ||
Parameters | osid.assessment.ItemQueryInspector | enrollmentQueryInspector | an enrollment query inspector |
Return | osid.course.program.EnrollmentQuery | the enrollment query | |
Errors | NULL_ARGUMENT | enrollmentQueryInspector is null | |
UNSUPPORTED | enrollmentQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |