| Interface | osid.course.program.EnrollmentSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description | The search interface for governing enrollment searches. | ||
| Method | searchAmongEnrollments | ||
| Description | Execute this search among the given list of enrollments. | ||
| Parameters | osid.id.IdList | enrollmentIds | list of enrollments | 
| Errors | NULL_ARGUMENT |  enrollmentIds is null  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderEnrollmentResults | ||
| Description | Specify an ordering to the search results. | ||
| Parameters | osid.course.program.EnrollmentSearchOrder | enrollmentSearchOrder | enrollment search order | 
| Errors | NULL_ARGUMENT |  enrollmentSearchOrder is null  | |
| UNSUPPORTED |  enrollmentSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getEnrollmentSearchRecord | ||
| Description | Gets the enrollment search record corresponding to the 
                    given enrollment search record  | ||
| Parameters | osid.type.Type | enrollmentSearchRecordType | an enrollment search record type | 
| Return | osid.course.program.records.EnrollmentSearchRecord | the enrollment search record | |
| Errors | NULL_ARGUMENT |  enrollmentSearchRecordType is null  | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED |  hasRecordType(enrollmentSearchRecordType) is false 
 | ||
| Compliance | mandatory | This method must be implemented. | |