public interface FunctionSearchOrder extends OsidRuleSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
FunctionSearchOrderRecord |
getFunctionSearchOrderRecord(Type functionRecordType)
Gets the function search order record corresponding to the given
function record
Type. |
HierarchySearchOrder |
getQualifierHierarchySearchOrder()
Gets the search order interface for a qualifier hierarchy.
|
void |
orderByQualifierHierarchy(SearchOrderStyle style)
Specified a preference for ordering results by the qualifier
hierarchy.
|
boolean |
supportsQualifierHierarchySearchOrder()
Tests if a
HierarchySearchOrder interface is available. |
getRuleSearchOrder, orderByRule, supportsRuleSearchOrder
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByActive, orderByDisabled, orderByEnabled, orderByOperational
void orderByQualifierHierarchy(SearchOrderStyle style)
style
- the search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsQualifierHierarchySearchOrder()
HierarchySearchOrder
interface is available. true
if a qualifier hierarchy search order
interface is available, false
otherwisemandatory
- This method must be implemented. HierarchySearchOrder getQualifierHierarchySearchOrder()
UnimplementedException
-
supportsQualifierHierarchySearchOrder()
is
false
optional
- This method must be implemented if
supportsQualifierHierarchySearchOrder()
is
true.
FunctionSearchOrderRecord getFunctionSearchOrderRecord(Type functionRecordType) throws OperationFailedException
Type.
Multiple retrievals return the
same underlying object.functionRecordType
- a function record typeNullArgumentException
- functionRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(functionRecordType)
is false
mandatory
- This method must be implemented.