OSID Logo
OSID Specifications
financials budgeting package
Version 3.1.0
Interfaceosid.financials.budgeting.BudgetSearchResults
Implementsosid.OsidSearchResults
Used Byosid.financials.budgeting.BudgetSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetBudgets
Description

Gets the budget list resulting from a search.

Returnosid.financials.budgeting.BudgetList the budget list
ErrorsILLEGAL_STATE the budget list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetBudgetQueryInspector
Description

Gets the inspector for the query to examine the periods used in the search.

Returnosid.financials.budgeting.BudgetQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetBudgetSearchResultsRecord
Description

Gets the budget search results 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 budget search record type
Returnosid.financials.budgeting.records.BudgetSearchResultsRecord the budget search results record
ErrorsNULL_ARGUMENT budgetSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(budgetSearchRecordType) is false
Compliancemandatory This method must be implemented.