Interface | osid.course.program.ProgramOfferingSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getProgramOfferings | ||
Description |
Gets the program offering list resulting from a search. | ||
Return | osid.course.program.ProgramOfferingList | the program offering list | |
Errors | ILLEGAL_STATE | the program offering list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getProgramOfferingQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.course.program.ProgramOfferingQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getProgramOfferingSearchResultsRecord | ||
Description |
Gets the program offering search results record
corresponding to the given program offering search record
| ||
Parameters | osid.type.Type | programOfferingSearchRecordType | a program offering search record type |
Return | osid.course.program.records.ProgramOfferingSearchResultsRecord | the program offering search results record | |
Errors | NULL_ARGUMENT | programOfferingSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(programOfferingSearchRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |