org.osid.mapping.path

Interface ObstacleSearchOrder

All Superinterfaces:

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

public interface ObstacleSearchOrder
extends OsidObjectSearchOrder, OsidOperableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
ObstacleSearchOrderRecord	getObstacleSearchOrderRecord(Type obstacleRecordType) Gets the obstacle search order record corresponding to the given obstacle record Type.
PathSearchOrder	getPathSearchOrder() Gets a path search order.
void	orderByLength(SearchOrderStyle style) Orders the results by the length of the obstacle.
void	orderByPath(SearchOrderStyle style) Orders the results by path.
boolean	supportsPathSearchOrder() Tests if a path search order 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

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

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getObstacleSearchOrderRecord

ObstacleSearchOrderRecord getObstacleSearchOrderRecord(Type obstacleRecordType)
                                                       throws OperationFailedException

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

Parameters:

obstacleRecordType - an obstacle record type

Returns:

the obstacle search order record

Throws:

NullArgumentException - obstacleRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(obstacleRecordType) is false

Compliance:

mandatory - This method must be implemented.