Interface | osid.recognition.ConvocationSearchOrder | ||
---|---|---|---|
Implements | osid.OsidGovernatorSearchOrder | ||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByDate | ||
Description |
Specifies a preference for ordering the result set by the date. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByTimePeriod | ||
Description |
Specifies a preference for ordering the result set by the time period. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsTimePeriodSearchOrder | ||
Description |
Tests if a time period order is available. | ||
Return | boolean | true if a time period order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getTimePeriodSearchOrder | ||
Description |
Gets the time period order. | ||
Return | osid.calendaring.TimePeriodSearchOrder | the time period search order | |
Errors | UNIMPLEMENTED | supportsTimePeriodSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsTimePeriodSearchOrder()
is true. | |
Method | getConvocationSearchOrderRecord | ||
Description |
Gets the convocation search order record corresponding
to the given convocation record | ||
Parameters | osid.type.Type | convocationRecordType | a convocation record type |
Return | osid.recognition.records.ConvocationSearchOrderRecord | the convocation search order record | |
Errors | NULL_ARGUMENT | convocationRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(convocationRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |