Interface BudgetSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface BudgetSearch
extends OsidSearch

The search interface for governing budget searches.

Method Summary

Modifier and Type	Method	Description
BudgetSearchRecord	getBudgetSearchRecord(Type budgetSearchRecordType)	Gets the budget search record corresponding to the given budget search record Type.
void	orderBudgetResults(BudgetSearchOrder budgetSearchOrder)	Specify an ordering to the search results.
void	searchAmongBudgets(IdList budgetIds)	Execute this search among the given list of budgets.

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

searchAmongBudgets

void searchAmongBudgets(IdList budgetIds)

Execute this search among the given list of budgets.

Parameters:

budgetIds - list of payers

Throws:

NullArgumentException - budgetIds is null

Compliance:

mandatory - This method must be implemented.

orderBudgetResults

void orderBudgetResults(BudgetSearchOrder budgetSearchOrder)

Specify an ordering to the search results.

Parameters:

budgetSearchOrder - payer search order

Throws:

NullArgumentException - budgetSearchOrder is null

UnsupportedException - budgetSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getBudgetSearchRecord

BudgetSearchRecord getBudgetSearchRecord(Type budgetSearchRecordType)
                                  throws OperationFailedException

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

Parameters:

budgetSearchRecordType - a payer search record type

Returns:

the budget search record

Throws:

NullArgumentException - budgetSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(budgetSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.