org.osid.topology

Interface NodeSearchOrder

All Superinterfaces:

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

public interface NodeSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
NodeSearchOrderRecord	getNodeSearchOrderRecord(Type nodeRecordType) Gets the node search order record corresponding to the given node 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

getNodeSearchOrderRecord

NodeSearchOrderRecord getNodeSearchOrderRecord(Type nodeRecordType)
                                               throws OperationFailedException

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

Parameters:

nodeRecordType - a node record type

Returns:

the node order record

Throws:

NullArgumentException - nodeRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(nodeRecordType) is false

Compliance:

mandatory - This method must be implemented.