public interface OsidEnablerSearchOrder extends OsidRuleSearchOrder, OsidTemporalSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
CyclicEventSearchOrder |
getCyclicEventSearchOrder()
Gets the cyclic event search order.
|
ResourceSearchOrder |
getDemographicSearchOrder()
Gets the search order for a demographic resource.
|
EventSearchOrder |
getEventSearchOrder()
Gets the search order for an event.
|
ScheduleSearchOrder |
getScheduleSearchOrder()
Gets the search order for a schedule.
|
void |
orderByCyclicEvent(SearchOrderStyle style)
Orders the results by cyclic event.
|
void |
orderByDemographic(SearchOrderStyle style)
Specifies a preference for ordering the results by the associated
demographic resource.
|
void |
orderByEvent(SearchOrderStyle style)
Specifies a preference for ordering the results by the associated
event.
|
void |
orderBySchedule(SearchOrderStyle style)
Specifies a preference for ordering the results by the associated
schedule.
|
boolean |
supportsCyclicEventSearchOrder()
Tests if a cyclic event search order is available.
|
boolean |
supportsDemographicSearchOrder()
Tests if a
ResourceSearchOrder is available. |
boolean |
supportsEventSearchOrder()
Tests if an
EventSearchOrder is available. |
boolean |
supportsScheduleSearchOrder()
Tests if a
ScheduleSearchOrder is available. |
getRuleSearchOrder, orderByRule, supportsRuleSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByActive, orderByDisabled, orderByEnabled, orderByOperational
orderByEffective, orderByEndDate, orderByStartDate
void orderBySchedule(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsScheduleSearchOrder()
ScheduleSearchOrder
is available. true
if a schedule search order is available,
false
otherwisemandatory
- This method must be implemented. ScheduleSearchOrder getScheduleSearchOrder()
UnimplementedException
-
supportsScheduleSearchOrder() is false
optional
- This method must be implemented if
supportsScheduleSearchOrder()
is true. void orderByEvent(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsEventSearchOrder()
EventSearchOrder
is available. true
if an event search order is available,
false
otherwisemandatory
- This method must be implemented. EventSearchOrder getEventSearchOrder()
UnimplementedException
-
supportsEventSearchOrder() is false
optional
- This method must be implemented if
supportsEventSearchOrder()
is true. void orderByCyclicEvent(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsCyclicEventSearchOrder()
true
if a cyclic event search order is
available, false
otherwisemandatory
- This method must be implemented. CyclicEventSearchOrder getCyclicEventSearchOrder()
IllegalStateException
-
supportsCyclicEventSearchOrder()
is false
mandatory
- This method must be implemented. void orderByDemographic(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsDemographicSearchOrder()
ResourceSearchOrder
is available. true
if a resource search order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getDemographicSearchOrder()
UnimplementedException
-
supportsDemographicSearchOrder()
is false
optional
- This method must be implemented if
supportsDemographicSearchOrder()
is true.