public interface EdgeSearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
NodeSearchOrder |
getDestinationNodeSearchOrder()
Gets a destination node search order.
|
EdgeSearchOrderRecord |
getEdgeSearchOrderRecord(Type edgeRecordType)
Gets the edge search order record corresponding to the given edge
record
Type. |
NodeSearchOrder |
getSourceNodeSearchOrder()
Gets a source node search order.
|
void |
orderByBiDirectional(SearchOrderStyle style)
Specifies a preference for ordering the result set by the
directionality.
|
void |
orderByCost(SearchOrderStyle style)
Specifies a preference for ordering the result set by the edge cost.
|
void |
orderByDestinationNode(SearchOrderStyle style)
Specifies a preference for ordering the result set by the destination
node.
|
void |
orderByDirectional(SearchOrderStyle style)
Specifies a preference for ordering the result set by the
directionality.
|
void |
orderByDistance(SearchOrderStyle style)
Specifies a preference for ordering the result set by the edge
distance.
|
void |
orderBySourceNode(SearchOrderStyle style)
Specifies a preference for ordering the result set by the source node.
|
boolean |
supportsDestinationNodeSearchOrder()
Tests if a destination node search order is available.
|
boolean |
supportsSourceNodeSearchOrder()
Tests if a source node search order is available.
|
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderBySourceNode(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsSourceNodeSearchOrder()
true
if a node search order is available,
false
otherwisemandatory
- This method must be implemented. NodeSearchOrder getSourceNodeSearchOrder()
UnimplementedException
-
supportsSourceNodeSearchOrder()
is false
optional
- This method must be implemented if
supportsSourceNodeSearchOrder()
is true.
void orderByDestinationNode(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsDestinationNodeSearchOrder()
true
if a node search order is available,
false
otherwisemandatory
- This method must be implemented. NodeSearchOrder getDestinationNodeSearchOrder()
UnimplementedException
-
supportsDestinationNodeSearchOrder()
is false
optional
- This method must be implemented if
supportsDestinationNodeSearchOrder()
is
true.
void orderByDirectional(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByBiDirectional(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByCost(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByDistance(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. EdgeSearchOrderRecord getEdgeSearchOrderRecord(Type edgeRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.edgeRecordType
- a edge record typeNullArgumentException
- edgeRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(edgeRecordType)
is false
mandatory
- This method must be implemented.