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

Modifier and Type	Method	Description
SubjectSearchOrderRecord	getSubjectSearchOrderRecord(Type subjectRecordType)	Gets the subject search order record corresponding to the given subject record Type .Multiple retrievals return the same underlying object.
void	orderByCode(SearchOrderStyle style)	Specifies a preference for ordering the result set by the code.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidIdentifiableSearchOrder

orderById

Modifier and Type	Method	Description
void	orderById(SearchOrderStyle style)	Specifies a preference for ordering the result set by the Id .

Methods inherited from interface OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Modifier and Type	Method	Description
void	orderByCreateTime(SearchOrderStyle style)	Orders by the timestamp of the first journal entry.
void	orderByCumulativeRating(Id bookId, SearchOrderStyle style)	Orders by the cumulative rating in a given Book .
void	orderByDescription(SearchOrderStyle style)	Specifies a preference for ordering the result set by the description.
void	orderByDisplayName(SearchOrderStyle style)	Specifies a preference for ordering the result set by the display name.
void	orderByGenusType(SearchOrderStyle style)	Specifies a preference for ordering the result set by the genus type.
void	orderByLastModifiedTime(SearchOrderStyle style)	Orders by the timestamp of the last journal entry.
void	orderByState(Id processId, SearchOrderStyle style)	Orders by the state in a given Process .
void	orderByStatistic(Id meterId, SearchOrderStyle style)	Orders by a statistic for a given Meter .

Method Details

orderByCode

void orderByCode(SearchOrderStyle style)

Specifies a preference for ordering the result set by the code.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

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.