Interface | osid.course.program.ProgramSearchOrder | ||
---|---|---|---|
Implements | osid.OsidObjectSearchOrder | ||
osid.OsidOperableSearchOrder | |||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByTitle | ||
Description |
Specifies a preference for ordering the result set by program title. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByNumber | ||
Description |
Specifies a preference for ordering the result set by program number. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByCompletionRequirementsInfo | ||
Description |
Specifies a preference for ordering the result set by program completion requirements. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getProgramSearchOrderRecord | ||
Description |
Gets the program search order record corresponding to
the given program record | ||
Parameters | osid.type.Type | programRecordType | a program record type |
Return | osid.course.program.records.ProgramSearchOrderRecord | the program search order record | |
Errors | NULL_ARGUMENT | programRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(programRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |