org.osid.mapping.path

Interface SpeedZoneSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, Suppliable

public interface SpeedZoneSearchOrder
extends OsidRuleSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
PathSearchOrder	getPathSearchOrder() Gets a path search order.
SpeedZoneSearchOrderRecord	getSpeedZoneSearchOrderRecord(Type speedZoneRecordType) Gets the speed zone search order record corresponding to the given speed zone record Type.
void	orderByLength(SearchOrderStyle style) Orders the results by the length of the zone.
void	orderByPath(SearchOrderStyle style) Orders the results by path.
void	orderBySpeedLimit(SearchOrderStyle style) Specifies a preference for ordering the results by speed limit.
boolean	supportsPathSearchOrder() Tests if a path search order is available.

Methods inherited from interface org.osid.OsidRuleSearchOrder

getRuleSearchOrder, orderByRule, supportsRuleSearchOrder

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.OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Method Detail

orderByPath

void orderByPath(SearchOrderStyle style)

Orders the results by path.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsPathSearchOrder

boolean supportsPathSearchOrder()

Tests if a path search order 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.

orderByLength

void orderByLength(SearchOrderStyle style)

Orders the results by the length of the zone.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderBySpeedLimit

void orderBySpeedLimit(SearchOrderStyle style)

Specifies a preference for ordering the results by speed limit.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getSpeedZoneSearchOrderRecord

SpeedZoneSearchOrderRecord getSpeedZoneSearchOrderRecord(Type speedZoneRecordType)
                                                         throws OperationFailedException

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

Parameters:

speedZoneRecordType - a speed zone record type

Returns:

the speed zone search order record

Throws:

NullArgumentException - speedZoneRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(speedZoneRecordType) is false

Compliance:

mandatory - This method must be implemented.