public interface EntrySearchOrder extends OsidObjectSearchOrder
This interface specifies options for ordering search results.
Modifier and Type | Method and 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.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderByKeyType(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByKey(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByValueType(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByValue(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. EntrySearchOrderRecord getEntrySearchOrderRecord(Type entryRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.entryRecordType
- an entry record typeNullArgumentException
- entryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(entryRecordType)
is false
mandatory
- This method must be implemented.