org.osid.control

Interface SceneSearchOrder

All Superinterfaces:

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

public interface SceneSearchOrder
extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
SceneSearchOrderRecord	getSceneSearchOrderRecord(Type sceneRecordType) Gets the scene search order record corresponding to the given scene 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

getSceneSearchOrderRecord

SceneSearchOrderRecord getSceneSearchOrderRecord(Type sceneRecordType)
                                                 throws OperationFailedException

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

Parameters:

sceneRecordType - a scene record type

Returns:

the scene order record interface

Throws:

NullArgumentException - sceneRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(sceneRecordType) is false

Compliance:

mandatory - This method must be implemented.