Interface | osid.resource.ResourceSearchOrder | ||
---|---|---|---|
Implements | osid.OsidObjectSearchOrder | ||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByGroup | ||
Description |
Groups the search results by resources that are groups. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByDemographic | ||
Description |
Groups the search results by resources that are demographics. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderByAvatar | ||
Description |
Orders the result set by avatar. | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsAvatarSearchOrder | ||
Description |
Tests if an | ||
Return | boolean | true if an asset search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAvatarSearchOrder | ||
Description |
Gets the search order for an asset. | ||
Return | osid.repository.AssetSearchOrder | the asset search order | |
Errors | UNIMPLEMENTED | supportsAvatarSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsAvatarSearchOrder()
is true. | |
Method | getResourceSearchOrderRecord | ||
Description |
Gets the resource search record corresponding to the
given resource record | ||
Parameters | osid.type.Type | resourceRecordType | a resource record type |
Return | osid.resource.records.ResourceSearchOrderRecord | the resource search order record | |
Errors | NULL_ARGUMENT | resourceRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(resourceRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |