public interface BillingSearch extends OsidSearch
The search interface for governing billing searches.
Modifier and Type | Method and Description |
---|---|
BillingSearchRecord |
getBillingSearchRecord(Type billingSearchRecordType)
Gets the record corresponding to the given billing search record
Type. |
void |
orderBillingResults(BillingSearchOrder billingSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongBillings(IdList billingIds)
Execute this search among the given list of billings.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongBillings(IdList billingIds)
billingIds
- list of billingsNullArgumentException
- billingIds
is
null
mandatory
- This method must be implemented. void orderBillingResults(BillingSearchOrder billingSearchOrder)
billingSearchOrder
- billing search orderNullArgumentException
- billingSearchOrder
is null
UnsupportedException
- billingSearchOrder
is not of this servicemandatory
- This method must be implemented. BillingSearchRecord getBillingSearchRecord(Type billingSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.billingSearchRecordType
- a billing search record typeNullArgumentException
- billingSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(billingSearchRecordType)
is false
mandatory
- This method must be implemented.