OSID Logo
OSID Specifications
financials budgeting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.budgeting.BudgetSearch
Implementsosid.OsidSearch
Description

The search interface for governing budget searches.

MethodsearchAmongBudgets
Description

Execute this search among the given list of budgets.

Parametersosid.id.IdListbudgetIdslist of payers
ErrorsNULL_ARGUMENT budgetIds is null
CompliancemandatoryThis method must be implemented.
MethodorderBudgetResults
Description

Specify an ordering to the search results.

Parametersosid.financials.budgeting.BudgetSearchOrderbudgetSearchOrderpayer search order
ErrorsNULL_ARGUMENT budgetSearchOrder is null
UNSUPPORTED budgetSearchOrder is not of this service
CompliancemandatoryThis 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.TypebudgetSearchRecordTypea payer search record type
Returnosid.financials.budgeting.records.BudgetSearchRecordthe budget search record
ErrorsNULL_ARGUMENT budgetSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(budgetSearchRecordType) is false
CompliancemandatoryThis method must be implemented.