org.osid.topology.path

Interface PathSearchOrder

All Superinterfaces:

Extensible, OsidAggregateableSearchOrder, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRelationshipSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable

public interface PathSearchOrder
extends OsidRelationshipSearchOrder, OsidAggregateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
NodeSearchOrder	getEndingNodeSearchOrder() Gets an ending node search order.
PathSearchOrderRecord	getPathSearchOrderRecord(Type pathRecordType) Gets the path search order record corresponding to the given path record Type.
NodeSearchOrder	getStartingNodeSearchOrder() Gets a starting node search order.
void	orderByClosed(SearchOrderStyle style) Specifies a preference for ordering the result set by the open and closed paths.
void	orderByComplete(SearchOrderStyle style) Specifies a preference for ordering the result set by the complete state.
void	orderByCost(SearchOrderStyle style) Specifies a preference for ordering the result set by the path cost.
void	orderByDistance(SearchOrderStyle style) Specifies a preference for ordering the result set by the path distance.
void	orderByEndingNode(SearchOrderStyle style) Specifies a preference for ordering the result set by the starting node.
void	orderByHops(SearchOrderStyle style) Specifies a preference for ordering the result set by the number of hops in the path.
void	orderByStartingNode(SearchOrderStyle style) Specifies a preference for ordering the result set by the starting node.
boolean	supportsEndingNodeSearchOrder() Tests if an ending node search order is available.
boolean	supportsStartingNodeSearchOrder() Tests if a starting node search order is available.

Methods inherited from interface org.osid.OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

orderByStartingNode

void orderByStartingNode(SearchOrderStyle style)

Specifies a preference for ordering the result set by the starting node.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsStartingNodeSearchOrder

boolean supportsStartingNodeSearchOrder()

Tests if a starting node search order is available.

Returns:

true if a node search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getStartingNodeSearchOrder

NodeSearchOrder getStartingNodeSearchOrder()

Gets a starting node search order.

Returns:

a node search order

Throws:

UnimplementedException - supportsStartingNodeSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsStartingNodeSearchOrder() is true.

orderByEndingNode

void orderByEndingNode(SearchOrderStyle style)

Specifies a preference for ordering the result set by the starting node.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsEndingNodeSearchOrder

boolean supportsEndingNodeSearchOrder()

Tests if an ending node search order is available.

Returns:

true if a node search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getEndingNodeSearchOrder

NodeSearchOrder getEndingNodeSearchOrder()

Gets an ending node search order.

Returns:

a node search order

Throws:

UnimplementedException - supportsEndingNodeSearchOrder() is false

Compliance:

optional - This method must be implemented if supportsEndingNodeSearchOrder() is true.

orderByComplete

void orderByComplete(SearchOrderStyle style)

Specifies a preference for ordering the result set by the complete state.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByClosed

void orderByClosed(SearchOrderStyle style)

Specifies a preference for ordering the result set by the open and closed paths.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByHops

void orderByHops(SearchOrderStyle style)

Specifies a preference for ordering the result set by the number of hops in the path.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByDistance

void orderByDistance(SearchOrderStyle style)

Specifies a preference for ordering the result set by the path distance.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByCost

void orderByCost(SearchOrderStyle style)

Specifies a preference for ordering the result set by the path cost.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getPathSearchOrderRecord

PathSearchOrderRecord getPathSearchOrderRecord(Type pathRecordType)
                                               throws OperationFailedException

Gets the path search order record corresponding to the given path record Type. Multiple retrievals return the same underlying object.

Parameters:

pathRecordType - a path record type

Returns:

the path search order record

Throws:

NullArgumentException - pathRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(pathRecordType) is false

Compliance:

mandatory - This method must be implemented.