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

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

Methods inherited from interface OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Modifier and Type	Method	Description
void	orderByActive(SearchOrderStyle style)	Specifies a preference for ordering the result set by the active status.
void	orderByDisabled(SearchOrderStyle style)	Specifies a preference for ordering the result set by the administratively disabled status.
void	orderByEnabled(SearchOrderStyle style)	Specifies a preference for ordering the result set by the administratively enabled status.
void	orderByOperational(SearchOrderStyle style)	Specifies a preference for ordering the results by the operational status.

Method Details

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