Interface EntrySearchOrder

All Superinterfaces:

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

public interface EntrySearchOrder
extends OsidObjectSearchOrder

This interface specifies options for ordering search results.

Method Summary

Modifier and Type	Method	Description
EntrySearchOrderRecord	getEntrySearchOrderRecord(Type entryRecordType)	Gets the entry search order record corresponding to the given entry record Type .
void	orderByKey(SearchOrderStyle style)	Specifies a preference for ordering the results by key.
void	orderByKeyType(SearchOrderStyle style)	Specifies a preference for ordering the results by key type.
void	orderByValue(SearchOrderStyle style)	Specifies a preference for ordering the results by value.
void	orderByValueType(SearchOrderStyle style)	Specifies a preference for ordering the results by value type.

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

orderByKeyType

void orderByKeyType(SearchOrderStyle style)

Specifies a preference for ordering the results by key type.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByKey

void orderByKey(SearchOrderStyle style)

Specifies a preference for ordering the results by key.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByValueType

void orderByValueType(SearchOrderStyle style)

Specifies a preference for ordering the results by value type.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

orderByValue

void orderByValue(SearchOrderStyle style)

Specifies a preference for ordering the results by value.

Parameters:

style - a search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getEntrySearchOrderRecord

EntrySearchOrderRecord getEntrySearchOrderRecord(Type entryRecordType)
                                          throws OperationFailedException

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

Parameters:

entryRecordType - an entry record type

Returns:

the entry search order record

Throws:

NullArgumentException - entryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(entryRecordType) is false

Compliance:

mandatory - This method must be implemented.