Interface RelevancySearchOrder

All Superinterfaces:

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

public interface RelevancySearchOrder
extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Modifier and Type	Method	Description
RelevancySearchOrderRecord	getRelevancySearchOrderRecord(Type relevancyRecordType)	Gets the relevancy search order record corresponding to the given commitment record Type .Multiple retrievals return the same underlying object.
SubjectSearchOrder	getSubjectSearchOrder()	Gets the search order for a subject.
void	orderBySubject(SearchOrderStyle style)	Specified a preference for ordering results by the subject.
boolean	supportsSubjectSearchOrder()	Tests if a SubjectSearchOrder is available.

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 .

Methods inherited from interface OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

Modifier and Type	Method	Description
StateSearchOrder	getEndReasonSearchOrder()	Gets the search order for a state.
void	orderByEndReason(SearchOrderStyle style)	Specifies a preference for ordering the results by the end reason state.
boolean	supportsEndReasonSearchOrder()	Tests if a StateSearchOrder is available.

Methods inherited from interface OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Modifier and Type	Method	Description
void	orderByEffective(SearchOrderStyle style)	Specifies a preference for ordering the result set by the effective status.
void	orderByEndDate(SearchOrderStyle style)	Specifies a preference for ordering the result set by the end date.
void	orderByStartDate(SearchOrderStyle style)	Specifies a preference for ordering the result set by the start date.

Method Details

orderBySubject

void orderBySubject(SearchOrderStyle style)

Specified a preference for ordering results by the subject.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

supportsSubjectSearchOrder

boolean supportsSubjectSearchOrder()

Tests if a SubjectSearchOrder is available.

Returns:

true if a subject search order is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSubjectSearchOrder

SubjectSearchOrder getSubjectSearchOrder()

Gets the search order for a subject.

Returns:

the subject search order

Throws:

UnimplementedException - supportsSubjectSearchOrder() is false

Compliance:

optional - This method must be implemented if {@code supportsSubjectSearchOrder()} is {@code true} .

getRelevancySearchOrderRecord

RelevancySearchOrderRecord getRelevancySearchOrderRecord(Type relevancyRecordType)
                                                  throws OperationFailedException

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

Parameters:

relevancyRecordType - a relevancy record type

Returns:

the relevancy search order record

Throws:

NullArgumentException - relevancyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(relevancyRecordType) is false

Compliance:

mandatory - This method must be implemented.