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

This session manages queries and sequencing to create "smart" dynamic catalogs. A BudgetQuery can be retrieved from this session and mapped to this CoursOfferingeCatalog to create a virtual collection of Budgets. The budgets may be sequenced using the BudgetSearchOrder from this session.

This Business has a default query that matches any budget and a default search order that specifies no sequencing. The queries may be examined using a BudgetQueryInspector. The query may be modified by converting the inspector back to a 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.
MethodcanManageSmartBusinesses
Description

Tests if this user can manage smart businesses. A return of true does not guarantee successful assessment. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.

Returnboolean false if smart business management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBudgetQuery
Description

Gets a budget query.

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

Gets a budget search order.

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

Applies a budget query to this business.

Parametersosid.financials.budgeting.BudgetQuerybudgetQuerythe budget query
ErrorsNULL_ARGUMENT budgetQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED budgetQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectBudgetQuery
Description

Gets a budget query inspector for this business.

Returnosid.financials.budgeting.BudgetQueryInspectorthe budget query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyBudgetSequencing
Description

Applies a budget search order to this business.

Parametersosid.financials.budgeting.BudgetSearchOrderbudgetSearchOrderthe budget search order
ErrorsNULL_ARGUMENT budgetSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED budgetSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetBudgetQueryFromInspector
Description

Gets a budget query from an inspector.

Parametersosid.financials.budgeting.BudgetQueryInspectorbudgetQueryInspectora 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.