Interface | osid.calendaring.TimePeriodSearchOrder | ||
---|---|---|---|
Implements | osid.OsidObjectSearchOrder | ||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByStart | ||
Description |
Specified a preference for ordering results by the start time. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByEnd | ||
Description |
Specified a preference for ordering results by the end time. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByDuration | ||
Description |
Specified a preference for ordering results by the time period duration. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getTimePeriodSearchOrderRecord | ||
Description |
Gets the time period search order record corresponding
to the given time period record | ||
Parameters | osid.type.Type | timePeriodRecordType | a time period record type |
Return | osid.calendaring.records.TimePeriodSearchOrderRecord | the time period search order record | |
Errors | NULL_ARGUMENT | timePeriodRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(timePeriodRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |