| Interface | osid.course.program.EnrollmentSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description | 
                 This interface provides a means to capture results of a search.  | ||
| Method | getEnrollments | ||
| Description | 
                     Gets the enrollment list resulting from a search.  | ||
| Return | osid.course.program.EnrollmentList | the enrollment list | |
| Errors | ILLEGAL_STATE | the enrollment list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEnrollmentQueryInspector | ||
| Description | 
                     Gets the inspector for the query to examine the terms used in the search.  | ||
| Return | osid.course.program.EnrollmentQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEnrollmentSearchResultsRecord | ||
| Description | 
                     Gets the enrollment search results record corresponding 
                    to the given enrollment search record   | ||
| Parameters | osid.type.Type | enrollmentSearchRecordType | an enrollment search record type | 
| Return | osid.course.program.records.EnrollmentSearchResultsRecord | the enrollment search interface | |
| Errors | NULL_ARGUMENT |  enrollmentSearchRecordType  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED |  hasRecordType(enrollmentSearchRecordType)  is  false 
  |                 ||
| Compliance | mandatory | This method must be implemented. | |