public interface SupersedingEventSearchOrder extends OsidRuleSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
EventSearchOrder |
getSupersededEventSearchOrder()
Gets the search order for the superseded event.
|
EventSearchOrder |
getSupersedingEventSearchOrder()
Gets the search order for the superseding event.
|
SupersedingEventSearchOrderRecord |
getSupersedingEventSearchOrderRecord(Type supersedingEventRecordType)
Gets the superseding event search order record corresponding to the
given superseding event record
Type. |
void |
orderBySupersededDate(SearchOrderStyle style)
Specified a preference for ordering results by the superseded date.
|
void |
orderBySupersededEvent(SearchOrderStyle style)
Specified a preference for ordering results by the superseded event.
|
void |
orderBySupersededEventPosition(SearchOrderStyle style)
Specified a preference for ordering results by the superseded event
position.
|
void |
orderBySupersedingEvent(SearchOrderStyle style)
Specified a preference for ordering results by the superseding event.
|
boolean |
supportsSupersededEventSearchOrder()
Tests if an
EventSearchOrder is available. |
boolean |
supportsSupersedingEventSearchOrder()
Tests if an
EventSearchOrder is available. |
getRuleSearchOrder, orderByRule, supportsRuleSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByActive, orderByDisabled, orderByEnabled, orderByOperational
void orderBySupersededEvent(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsSupersededEventSearchOrder()
EventSearchOrder
is available. true
if an event search order is available,
false
otherwisemandatory
- This method must be implemented. EventSearchOrder getSupersededEventSearchOrder()
UnimplementedException
-
supportsSupersededEventSearchOrder()
is false
optional
- This method must be implemented if
supportsSupersededEventSearchOrder()
is
true.
void orderBySupersedingEvent(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsSupersedingEventSearchOrder()
EventSearchOrder
is available. true
if an event search order is available,
false
otherwisemandatory
- This method must be implemented. EventSearchOrder getSupersedingEventSearchOrder()
UnimplementedException
-
supportsSupersedingEventSearchOrder()
is false
optional
- This method must be implemented if
supportsSupersedingEventSearchOrder()
is
true.
void orderBySupersededDate(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderBySupersededEventPosition(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. SupersedingEventSearchOrderRecord getSupersedingEventSearchOrderRecord(Type supersedingEventRecordType) throws OperationFailedException
Type.
Multiple
retrievals return the same underlying object.supersedingEventRecordType
- a superseding event record typeNullArgumentException
-
supersedingEventRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(supersedingEventRecordType)
is
false
mandatory
- This method must be implemented.