org.osid.mapping.path

Interface IntersectionSearchOrder

All Superinterfaces:

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

public interface IntersectionSearchOrder
extends OsidObjectSearchOrder, OsidAggregateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

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.

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

Method Detail

supportsPathSearchOrder

boolean supportsPathSearchOrder()

Tests if a search order for the path is available.

Returns:

true if a path search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPathSearchOrder

PathSearchOrder getPathSearchOrder()

Gets a path search order.

Returns:

the path search order

Throws:

UnimplementedException - supportsPathSearchOrder() is false

Compliance:

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

orderByRotary

void orderByRotary(SearchOrderStyle style)

Specifies a preference for ordering the results by rotaries.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByFork

void orderByFork(SearchOrderStyle style)

Specifies a preference for ordering the results by forks.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getIntersectionSearchOrderRecord

IntersectionSearchOrderRecord getIntersectionSearchOrderRecord(Type intersectionRecordType)
                                                               throws OperationFailedException

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

Parameters:

intersectionRecordType - a route record type

Returns:

the route search order record

Throws:

NullArgumentException - intersectionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(intersectionRecordType) is false

Compliance:

mandatory - This method must be implemented.