org.osid.mapping.path

Interface SignalSearchOrder

All Superinterfaces:

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

public interface SignalSearchOrder
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.
SignalSearchOrderRecord	getSignalSearchOrderRecord(Type signalRecordType) Gets the signal search order record corresponding to the given signal record Type.
void	orderByPath(SearchOrderStyle style) Specifies a preference for ordering the results by path.
boolean	supportsPathSearchOrder() Tests if a search order for the path 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)

Specifies a preference for ordering 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 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.

getSignalSearchOrderRecord

SignalSearchOrderRecord getSignalSearchOrderRecord(Type signalRecordType)
                                                   throws OperationFailedException

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

Parameters:

signalRecordType - a signal record type

Returns:

the signal search order record

Throws:

NullArgumentException - signalRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(signalRecordType) is false

Compliance:

mandatory - This method must be implemented.