public interface PayerSearchOrder extends OsidObjectSearchOrder, OsidTemporalSearchOrder
An interface for specifying the ordering of search results.
Modifier and Type | Method and Description |
---|---|
CustomerSearchOrder |
getCustomerSearchOrder()
Specifies a preference for ordering the result set by the customer.
|
PayerSearchOrderRecord |
getPayerSearchOrderRecord(Type payerRecordType)
Gets the payer search order record corresponding to the given payer
record
Type. |
ResourceSearchOrder |
getResourceSearchOrder()
Specifies a preference for ordering the result set by the resource.
|
void |
orderByBankAccountNumber(SearchOrderStyle style)
Specifies a preference for ordering the result set by the bank account
number.
|
void |
orderByBankRoutingNumber(SearchOrderStyle style)
Specifies a preference for ordering the result set by the bank routing
number.
|
void |
orderByCreditCardCode(SearchOrderStyle style)
Specifies a preference for ordering the result set by the credit card
code.
|
void |
orderByCreditCardExpiration(SearchOrderStyle style)
Specifies a preference for ordering the result set by the credit card
expiration.
|
void |
orderByCreditCardNumber(SearchOrderStyle style)
Specifies a preference for ordering the result set by the credit card
number.
|
void |
orderByCustomer(SearchOrderStyle style)
Specifies a preference for ordering the result set by the customer.
|
void |
orderByResource(SearchOrderStyle style)
Specifies a preference for ordering the result set by the resource.
|
void |
orderByUsesActivity(SearchOrderStyle style)
Specifies a preference for ordering the result set by activity based
customers.
|
void |
orderByUsesCash(SearchOrderStyle style)
Specifies a preference for ordering the result set by cash customers.
|
boolean |
supportsCustomerSearchOrder()
Tests if a customer search order is available.
|
boolean |
supportsResourceSearchOrder()
Tests if a resource search order is available.
|
orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic
orderById
getRecordTypes, hasRecordType
orderByEffective, orderByEndDate, orderByStartDate
void orderByResource(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsResourceSearchOrder()
true
if a resource search order is available,
false
otherwisemandatory
- This method must be implemented. ResourceSearchOrder getResourceSearchOrder()
UnimplementedException
-
supportsResourceSearchOrder()
is false
optional
- This method must be implemented if
supportsResourceSearchOrder()
is true.
void orderByCustomer(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. boolean supportsCustomerSearchOrder()
true
if a customer search order is available,
false
otherwisemandatory
- This method must be implemented. CustomerSearchOrder getCustomerSearchOrder()
UnimplementedException
-
supportsCustomerSearchOrder()
is false
optional
- This method must be implemented if
supportsCustomerSearchOrder()
is true.
void orderByUsesActivity(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByUsesCash(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByCreditCardNumber(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByCreditCardExpiration(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByCreditCardCode(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByBankRoutingNumber(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. void orderByBankAccountNumber(SearchOrderStyle style)
style
- a search order styleNullArgumentException
- style
is
null
mandatory
- This method must be implemented. PayerSearchOrderRecord getPayerSearchOrderRecord(Type payerRecordType) throws OperationFailedException
Type.
Multiple retrievals return the same
underlying object.payerRecordType
- a payer record typeNullArgumentException
- payerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(payerRecordType)
is false
mandatory
- This method must be implemented.