org.osid.mapping.path

Interface PathSearchOrder

All Superinterfaces:

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

public interface PathSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
PathSearchOrderRecord	getPathSearchOrderRecord(Type pathRecordType) Gets the path order record corresponding to the given path 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

Method Detail

getPathSearchOrderRecord

PathSearchOrderRecord getPathSearchOrderRecord(Type pathRecordType)
                                               throws OperationFailedException

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

Parameters:

pathRecordType - a path record type

Returns:

the path search order record

Throws:

NullArgumentException - pathRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(pathRecordType) is false

Compliance:

mandatory - This method must be implemented.