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

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

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 query record types. The query record is accessed via the BudgetQuery.

MethodgetBusinessId
Description

Gets the Business Id associated with this session.

Returnosid.id.Idthe Business Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBusiness
Description

Gets the Business associated with this session.

Returnosid.financials.Businessthe business
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchBudgets
Description

Tests if this user can perform Budget lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedBusinessView
Description

Federates the view for methods in this session. A federated view will include budgets in business which are children of this business in the business hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedBusinessView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this business only.

CompliancemandatoryThis method is must be implemented.
MethodgetBudgetQuery
Description

Gets a budget query.

Returnosid.financials.budgeting.BudgetQuerythe budget query.
CompliancemandatoryThis method must be implemented.
MethodgetBudgetsByQuery
Description

Gets a list of Budgets matching the given budget query.

Parametersosid.financials.budgeting.BudgetQuerybudgetQuerythe budget query
Returnosid.financials.budgeting.BudgetListthe returned BudgetList
ErrorsNULL_ARGUMENT budgetQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED budgetQuery is not of this service
CompliancemandatoryThis method must be implemented.