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

This session manages queries and sequencing to create "smart" dynamic catalogs. An BudgetEntryQuery can be retrieved from this session and mapped to this Business to create a virtual collection of BudgetEntries. The budget entries may be sequenced using the BudgetEntrySearchOrder from this session.

This Business has a default query that matches any budget entry and a default search order that specifies no sequencing. The queries may be examined using an BudgetEntryQueryInspector. The query may be modified by converting the inspector back to an BudgetEntryQuery.

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.
MethodgetBudgetEntryQuery
Description

Gets a budget entry query.

Returnosid.financials.budgeting.BudgetEntryQuerythe budget entry query
CompliancemandatoryThis method must be implemented.
MethodgetBudgetEntrySearchOrder
Description

Gets a budget entry search order.

Returnosid.financials.budgeting.BudgetEntrySearchOrderthe budget entry search order
CompliancemandatoryThis method must be implemented.
MethodapplyBudgetEntryQuery
Description

Applies a budget entry query to this business.

Parametersosid.financials.budgeting.BudgetEntryQuerybudgetEntryQuerythe budget entry query
ErrorsNULL_ARGUMENT budgetEntryQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED budgetEntryQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectBudgetEntryQuery
Description

Gets a budget entry query inspector for this business.

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

Applies a budget entry search order to this business.

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

Gets a budget entry query from an inspector.

Parametersosid.financials.budgeting.BudgetEntryQueryInspectorbudgetEntryQueryInspectora query inspector
Returnosid.financials.budgeting.BudgetEntryQuerythe budget entry query
ErrorsNULL_ARGUMENT budgetEntryQueryInspector is null
UNSUPPORTED budgetEntryQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.