public interface TimePeriodSearchOrder extends OsidObjectSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
TimePeriodSearchOrderRecord |
getTimePeriodSearchOrderRecord(Type timePeriodRecordType)
Gets the time period search order record corresponding to the given
time period record
Type. |
void |
orderByDuration(SearchOrderStyle style)
Specified a preference for ordering results by the time period
duration.
|
void |
orderByEnd(SearchOrderStyle style)
Specified a preference for ordering results by the end time.
|
void |
orderByStart(SearchOrderStyle style)
Specified a preference for ordering results by the start time.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderByStart(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByEnd(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByDuration(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. TimePeriodSearchOrderRecord getTimePeriodSearchOrderRecord(Type timePeriodRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.timePeriodRecordType
- a time period record typeNullArgumentException
- timePeriodRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(timePeriodRecordType)
is false
mandatory
- This method must be implemented.