| Interface | osid.financials.budgeting.BudgetSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing budget searches. | ||
| Method | searchAmongBudgets | ||
| Description |
Execute this search among the given list of budgets. | ||
| Parameters | osid.id.IdList | budgetIds | list of payers |
| Errors | NULL_ARGUMENT | budgetIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderBudgetResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.financials.budgeting.BudgetSearchOrder | budgetSearchOrder | payer search order |
| Errors | NULL_ARGUMENT | budgetSearchOrder is null | |
| UNSUPPORTED | budgetSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getBudgetSearchRecord | ||
| Description |
Gets the budget search record corresponding to the
given budget search record | ||
| Parameters | osid.type.Type | budgetSearchRecordType | a payer search record type |
| Return | osid.financials.budgeting.records.BudgetSearchRecord | the budget search record | |
| Errors | NULL_ARGUMENT | budgetSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(budgetSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |