public interface ResourceSearchOrder extends OsidObjectSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
AssetSearchOrder |
getAvatarSearchOrder()
Gets the search order for an asset.
|
ResourceSearchOrderRecord |
getResourceSearchOrderRecord(Type resourceRecordType)
Gets the resource search record corresponding to the given resource
record
Type. |
void |
orderByAvatar(SearchOrderStyle style)
Orders the result set by avatar.
|
void |
orderByDemographic(SearchOrderStyle style)
Groups the search results by resources that are demographics.
|
void |
orderByGroup(SearchOrderStyle style)
Groups the search results by resources that are groups.
|
boolean |
supportsAvatarSearchOrder()
Tests if an
AssetSearchOrder is available. |
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderByGroup(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByDemographic(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByAvatar(SearchOrderStyle style)
style
- search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsAvatarSearchOrder()
AssetSearchOrder
is available. true
if an asset search order is available,
false
otherwisemandatory
- This method must be implemented. AssetSearchOrder getAvatarSearchOrder()
UnimplementedException
-
supportsAvatarSearchOrder()
is false
optional
- This method must be implemented if
supportsAvatarSearchOrder()
is true.
ResourceSearchOrderRecord getResourceSearchOrderRecord(Type resourceRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.resourceRecordType
- a resource record typeNullArgumentException
- resourceRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(resourceRecordType)
is false
mandatory
- This method must be implemented.