Interface BillingSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface BillingSearch
extends OsidSearch

The search interface for governing billing searches.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongBillings

void searchAmongBillings(IdList billingIds)

Execute this search among the given list of billings.

Parameters:

billingIds - list of billings

Throws:

NullArgumentException - billingIds is null

Compliance:

mandatory - This method must be implemented.

orderBillingResults

void orderBillingResults(BillingSearchOrder billingSearchOrder)

Specify an ordering to the search results.

Parameters:

billingSearchOrder - billing search order

Throws:

NullArgumentException - billingSearchOrder is null

UnsupportedException - billingSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getBillingSearchRecord

BillingSearchRecord getBillingSearchRecord(Type billingSearchRecordType)
                                    throws OperationFailedException

Gets the record corresponding to the given billing search record Type . This method is used to retrieve an object implementing the requested record.

Parameters:

billingSearchRecordType - a billing search record type

Returns:

the billing search record

Throws:

NullArgumentException - billingSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(billingSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.