org.osid.configuration

Interface ParameterSearchOrder

All Superinterfaces:

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

public interface ParameterSearchOrder
extends OsidRuleSearchOrder

This interface specifies options for ordering search results.

Method Summary

Methods

Modifier and Type	Method and Description
ParameterSearchOrderRecord	getParameterSearchOrderRecord(Type parameterRecordType) Gets the parameter search order record corresponding to the given parameter record Type.
void	orderByValuesShuffled(SearchOrderStyle style) Specifies a preference for ordering the results by the shuffle flag.
void	orderByValueSyntax(SearchOrderStyle style) Specifies a preference for ordering the results by the value syntax and object type.

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

orderByValueSyntax

void orderByValueSyntax(SearchOrderStyle style)

Specifies a preference for ordering the results by the value syntax and object type.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByValuesShuffled

void orderByValuesShuffled(SearchOrderStyle style)

Specifies a preference for ordering the results by the shuffle flag.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getParameterSearchOrderRecord

ParameterSearchOrderRecord getParameterSearchOrderRecord(Type parameterRecordType)
                                                         throws OperationFailedException

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

Parameters:

parameterRecordType - a parameter record type

Returns:

the parameter search order record

Throws:

NullArgumentException - parameterRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(parameterRecordType) is false

Compliance:

mandatory - This method must be implemented.