org.osid.ontology

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

Methods

Modifier and Type	Method and Description
RelevancySearchOrderRecord	getRelevancySearchOrderRecord(Type relevancyRecordType) Gets the relevancy search order record corresponding to the given commitment record Type.
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 org.osid.OsidRelationshipSearchOrder

getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder

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

Methods inherited from interface org.osid.OsidTemporalSearchOrder

orderByEffective, orderByEndDate, orderByStartDate

Method Detail

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 supportsSubjectSearchOrder() is 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.