public interface IntersectionSearchOrder extends OsidObjectSearchOrder, OsidAggregateableSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
IntersectionSearchOrderRecord |
getIntersectionSearchOrderRecord(Type intersectionRecordType)
Gets the intersection search order record corresponding to the given
intersection record
Type. |
PathSearchOrder |
getPathSearchOrder()
Gets a path search order.
|
void |
orderByFork(SearchOrderStyle style)
Specifies a preference for ordering the results by forks.
|
void |
orderByRotary(SearchOrderStyle style)
Specifies a preference for ordering the results by rotaries.
|
boolean |
supportsPathSearchOrder()
Tests if a search order for the path is available.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
boolean supportsPathSearchOrder()
true
if a path search order is available,
false
otherwisemandatory
- This method must be implemented. PathSearchOrder getPathSearchOrder()
UnimplementedException
-
supportsPathSearchOrder()
is false
optional
- This method must be implemented if
supportsPathSearchOrder()
is true.
void orderByRotary(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByFork(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. IntersectionSearchOrderRecord getIntersectionSearchOrderRecord(Type intersectionRecordType) throws OperationFailedException
Type.
Multiple retrievals return
the same underlying object.intersectionRecordType
- a route record typeNullArgumentException
- intersectionRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(intersectionRecordType)
is false
mandatory
- This method must be implemented.