org.osid.ontology

Interface SubjectSearchOrder

All Superinterfaces:

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

public interface SubjectSearchOrder
extends OsidObjectSearchOrder, OsidFederateableSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
SubjectSearchOrderRecord	getSubjectSearchOrderRecord(Type subjectRecordType) Gets the subject search order record corresponding to the given subject 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

getSubjectSearchOrderRecord

SubjectSearchOrderRecord getSubjectSearchOrderRecord(Type subjectRecordType)
                                                     throws OperationFailedException

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

Parameters:

subjectRecordType - a subject record type

Returns:

the subject search order record

Throws:

NullArgumentException - subjectRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(subjectRecordType) is false

Compliance:

mandatory - This method must be implemented.