public interface BudgetSearch extends OsidSearch
The search interface for governing budget searches.
Modifier and Type | Method and 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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongBudgets(IdList budgetIds)
budgetIds
- list of payersNullArgumentException
- budgetIds
is
null
mandatory
- This method must be implemented. void orderBudgetResults(BudgetSearchOrder budgetSearchOrder)
budgetSearchOrder
- payer search orderNullArgumentException
- budgetSearchOrder
is null
UnsupportedException
- budgetSearchOrder
is not of this servicemandatory
- This method must be implemented. BudgetSearchRecord getBudgetSearchRecord(Type budgetSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.budgetSearchRecordType
- a payer search record typeNullArgumentException
- budgetSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(budgetSearchRecordType)
is false
mandatory
- This method must be implemented.