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

Modifier and Type	Method	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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

Modifier and Type	Method	Description
void	orderById(SearchOrderStyle style)	Specifies a preference for ordering the result set by the Id .

Methods inherited from interface OsidObjectSearchOrder

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

Modifier and Type	Method	Description
void	orderByCreateTime(SearchOrderStyle style)	Orders by the timestamp of the first journal entry.
void	orderByCumulativeRating(Id bookId, SearchOrderStyle style)	Orders by the cumulative rating in a given Book .
void	orderByDescription(SearchOrderStyle style)	Specifies a preference for ordering the result set by the description.
void	orderByDisplayName(SearchOrderStyle style)	Specifies a preference for ordering the result set by the display name.
void	orderByGenusType(SearchOrderStyle style)	Specifies a preference for ordering the result set by the genus type.
void	orderByLastModifiedTime(SearchOrderStyle style)	Orders by the timestamp of the last journal entry.
void	orderByState(Id processId, SearchOrderStyle style)	Orders by the state in a given Process .
void	orderByStatistic(Id meterId, SearchOrderStyle style)	Orders by a statistic for a given Meter .

Method Details

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 {@code supportsPathSearchOrder()} is {@code 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.