public interface ConvocationSearchOrder extends OsidGovernatorSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
ConvocationSearchOrderRecord |
getConvocationSearchOrderRecord(Type convocationRecordType)
Gets the convocation search order record corresponding to the given
convocation record
Type. |
TimePeriodSearchOrder |
getTimePeriodSearchOrder()
Gets the time period order.
|
void |
orderByDate(SearchOrderStyle style)
Specifies a preference for ordering the result set by the date.
|
void |
orderByTimePeriod(SearchOrderStyle style)
Specifies a preference for ordering the result set by the time period.
|
boolean |
supportsTimePeriodSearchOrder()
Tests if a time period order is available.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByActive, orderByDisabled, orderByEnabled, orderByOperational
getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder
void orderByDate(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByTimePeriod(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsTimePeriodSearchOrder()
true
if a time period order is available,
false
otherwisemandatory
- This method must be implemented. TimePeriodSearchOrder getTimePeriodSearchOrder()
UnimplementedException
-
supportsTimePeriodSearchOrder()
is false
optional
- This method must be implemented if
supportsTimePeriodSearchOrder()
is true.
ConvocationSearchOrderRecord getConvocationSearchOrderRecord(Type convocationRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.convocationRecordType
- a convocation record typeNullArgumentException
- convocationRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(convocationRecordType)
is false
mandatory
- This method must be implemented.