org.osid.hierarchy

Interface HierarchySearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidCatalogSearchOrder, OsidExtensibleSearchOrder, OsidFederateableSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface HierarchySearchOrder
extends OsidCatalogSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
HierarchySearchOrderRecord	getHierarchySearchOrderRecord(Type hierarchyRecordType) Gets the hierarchy search order record corresponding to the given hierarchy record Type.

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

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

Method Detail

getHierarchySearchOrderRecord

HierarchySearchOrderRecord getHierarchySearchOrderRecord(Type hierarchyRecordType)
                                                         throws OperationFailedException

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

Parameters:

hierarchyRecordType - a hierarchy record type

Returns:

the hierarchy search order record

Throws:

NullArgumentException - hierarchyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(hierarchyRecordType) is false

Compliance:

mandatory - This method must be implemented.