org.osid.authorization

Interface FunctionSearchOrder

All Superinterfaces:

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

public interface FunctionSearchOrder
extends OsidRuleSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
FunctionSearchOrderRecord	getFunctionSearchOrderRecord(Type functionRecordType) Gets the function search order record corresponding to the given function record Type.
HierarchySearchOrder	getQualifierHierarchySearchOrder() Gets the search order interface for a qualifier hierarchy.
void	orderByQualifierHierarchy(SearchOrderStyle style) Specified a preference for ordering results by the qualifier hierarchy.
boolean	supportsQualifierHierarchySearchOrder() Tests if a HierarchySearchOrder interface 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

orderByQualifierHierarchy

void orderByQualifierHierarchy(SearchOrderStyle style)

Specified a preference for ordering results by the qualifier hierarchy.

Parameters:

style - the search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsQualifierHierarchySearchOrder

boolean supportsQualifierHierarchySearchOrder()

Tests if a HierarchySearchOrder interface is available.

Returns:

true if a qualifier hierarchy search order interface is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getQualifierHierarchySearchOrder

HierarchySearchOrder getQualifierHierarchySearchOrder()

Gets the search order interface for a qualifier hierarchy.

Returns:

the hierarchy search order

Throws:

UnimplementedException - supportsQualifierHierarchySearchOrder() is false

Compliance:

optional - This method must be implemented if supportsQualifierHierarchySearchOrder() is true.

getFunctionSearchOrderRecord

FunctionSearchOrderRecord getFunctionSearchOrderRecord(Type functionRecordType)
                                                       throws OperationFailedException

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

Parameters:

functionRecordType - a function record type

Returns:

the function search order record

Throws:

NullArgumentException - functionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(functionRecordType) is false

Compliance:

mandatory - This method must be implemented.