OSID Logo
OSID Specifications
financials budgeting package
Version 3.1.0
Interfaceosid.financials.budgeting.BudgetSearch
Implementsosid.OsidSearch
Used Byosid.financials.budgeting.BudgetSearchSession
Description

The search interface for governing budget searches.

MethodsearchAmongBudgets
Description

Execute this search among the given list of budgets.

Parametersosid.id.IdListbudgetIds list of payers
ErrorsNULL_ARGUMENT budgetIds is null
Compliancemandatory This method must be implemented.
MethodorderBudgetResults
Description

Specify an ordering to the search results.

Parametersosid.financials.budgeting.BudgetSearchOrderbudgetSearchOrder payer search order
ErrorsNULL_ARGUMENT budgetSearchOrder is null
UNSUPPORTED budgetSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetBudgetSearchRecord
Description

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.

Parametersosid.type.TypebudgetSearchRecordType a payer search record type
Returnosid.financials.budgeting.records.BudgetSearchRecord the budget search record
ErrorsNULL_ARGUMENT budgetSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(budgetSearchRecordType) is false
Compliancemandatory This method must be implemented.