| Interface | osid.course.program.ProgramSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description | This interface provides a means to capture results of a search. | ||
| Method | getPrograms | ||
| Description | Gets the program list resulting from a search. | ||
| Return | osid.course.program.ProgramList | the program list | |
| Errors | ILLEGAL_STATE | the program list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProgramQueryInspector | ||
| Description | Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.course.program.ProgramQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProgramSearchResultsRecord | ||
| Description | Gets the program search results record corresponding to 
                    the given program search record  | ||
| Parameters | osid.type.Type | programSearchRecordType | a program search record type | 
| Return | osid.course.program.records.ProgramSearchResultsRecord | the program search results record | |
| Errors | NULL_ARGUMENT |  programSearchRecordType is null  | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED |  hasRecordType(programSearchRecordType) is false 
 | ||
| Compliance | mandatory | This method must be implemented. | |