public interface RelevancySearchOrder extends OsidRelationshipSearchOrder
An interface for specifying the ordering of search results.
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. |
getEndReasonSearchOrder, orderByEndReason, supportsEndReasonSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderBySubject(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsSubjectSearchOrder()
SubjectSearchOrder
is available. true
if a subject search order is available,
false
otherwisemandatory
- This method must be implemented. SubjectSearchOrder getSubjectSearchOrder()
UnimplementedException
-
supportsSubjectSearchOrder()
is false
optional
- This method must be implemented if
supportsSubjectSearchOrder()
is true.
RelevancySearchOrderRecord getRelevancySearchOrderRecord(Type relevancyRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.relevancyRecordType
- a relevancy record typeNullArgumentException
- relevancyRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(relevancyRecordType)
is false
mandatory
- This method must be implemented.