public interface ItemSearchOrder extends OsidObjectSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
AccountSearchOrder |
getAccountSearchOrder()
Specifies a preference for ordering the result set by the account.
|
CategorySearchOrder |
getCategorySearchOrder()
Specifies a preference for ordering the result set by the category.
|
ItemSearchOrderRecord |
getItemSearchOrderRecord(Type itemRecordType)
Gets the item search order record corresponding to the given item
record
Type. |
ProductSearchOrder |
getProductSearchOrder()
Specifies a preference for ordering the result set by the product.
|
void |
orderByAccount(SearchOrderStyle style)
Specifies a preference for ordering the result set by the account.
|
void |
orderByAmount(SearchOrderStyle style)
Specifies a preference for ordering the result set by the amount.
|
void |
orderByCategory(SearchOrderStyle style)
Specifies a preference for ordering the result set by the category.
|
void |
orderByDebit(SearchOrderStyle style)
Specifies a preference for ordering the result set by debit.
|
void |
orderByProduct(SearchOrderStyle style)
Specifies a preference for ordering the result set by the product.
|
void |
orderByRecurringInterval(SearchOrderStyle style)
Specifies a preference for ordering the result set by interval.
|
boolean |
supportsAccountSearchOrder()
Tests if an account search order is available.
|
boolean |
supportsCategorySearchOrder()
Tests if a category search order is available.
|
boolean |
supportsProductSearchOrder()
Tests if a product search order is available.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
void orderByCategory(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsCategorySearchOrder()
true
if a category search order is available,
false
otherwisemandatory
- This method must be implemented. CategorySearchOrder getCategorySearchOrder()
UnimplementedException
-
supportsCategorySearchOrder()
is false
optional
- This method must be implemented if
supportsCategorySearchOrder()
is true.
void orderByAccount(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsAccountSearchOrder()
true
if an account search order is available,
false
otherwisemandatory
- This method must be implemented. AccountSearchOrder getAccountSearchOrder()
UnimplementedException
-
supportsAccountSearchOrder()
is false
optional
- This method must be implemented if
supportsAccountSearchOrder()
is true.
void orderByProduct(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsProductSearchOrder()
true
if a product search order is available,
false
otherwisemandatory
- This method must be implemented. ProductSearchOrder getProductSearchOrder()
UnimplementedException
-
supportsProductSearchOrder()
is false
optional
- This method must be implemented if
supportsProductSearchOrder()
is true.
void orderByAmount(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByDebit(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByRecurringInterval(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. ItemSearchOrderRecord getItemSearchOrderRecord(Type itemRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.itemRecordType
- an item record typeNullArgumentException
- itemRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(itemRecordType)
is false
mandatory
- This method must be implemented.