OSID Logo
OSID Specifications
financials budgeting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.budgeting.BudgetSearchSession
Implementsosid.financials.budgeting.BudgetQuerySession
Description

This session provides methods for searching among Budget objects. The search query is constructed using the BudgetQuery.

getBudgetsByQuery() is the basic search method and returns a list of Budgets. A more advanced search may be performed with getBudgetsBySearch(). It accepts a BudgetSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getBudgetsBySearch() returns a BudgetSearchResults that can be used to access the resulting BudgetList or be used to perform a search within the result set through BudgetSearch.

This session defines views that offer differing behaviors for searching.

  • federated business view: searches include budgets in businesses of which this business is an ancestor in the business hierarchy
  • isolated business view: searches are restricted to budgets in this business

Budgets may have a query record indicated by their respective record types. The queryrecord is accessed via the BudgetQuery.

MethodgetBudgetSearch
Description

Gets a budget search.

Returnosid.financials.budgeting.BudgetSearchthe budget search
CompliancemandatoryThis method must be implemented.
MethodgetBudgetSearchOrder
Description

Gets a budget search order. The BudgetSearchOrder is supplied to a BudgetSearch to specify the ordering of results.

Returnosid.financials.budgeting.BudgetSearchOrderthe budget search order
CompliancemandatoryThis method must be implemented.
MethodgetBudgetsBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.financials.budgeting.BudgetQuerybudgetQuerythe budget query
osid.financials.budgeting.BudgetSearchbudgetSearchthe budget search
Returnosid.financials.budgeting.BudgetSearchResultsthe budget search results
ErrorsNULL_ARGUMENT budgetQuery or budgetSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED budgetQuery or budgetSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetBudgetQueryFromInspector
Description

Gets a budget query from an inspector. The inspector is available from a BudgetSearchResults.

Parametersosid.assessment.ItemQueryInspectorbudgetQueryInspectora budget query inspector
Returnosid.financials.budgeting.BudgetQuerythe budget query
ErrorsNULL_ARGUMENT budgetQueryInspector is null
UNSUPPORTED budgetQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.