OSID Logo
OSID Specifications
financials package
Version 3.1.0
Interfaceosid.financials.AccountSmartBusinessSession
Implementsosid.OsidSession
Used Byosid.financials.FinancialsManager
osid.financials.FinancialsProxyManager
Description

This session manages queries and sequencing to create "smart" dynamic catalogs. An AccountQuery can be retrieved from this session and mapped to this Business to create a virtual collection of Accounts. The accounts may be sequenced using the AccountSearchOrder from this session.

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

MethodgetBusinessId
Description

Gets the Business Id associated with this session.

Returnosid.id.Id the Business Id associated with this session
Compliancemandatory This method must be implemented.
MethodgetBusiness
Description

Gets the Business associated with this session.

Returnosid.financials.Business the business
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This 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
Compliancemandatory This method must be implemented.
MethodgetAccountQuery
Description

Gets an account query.

Returnosid.financials.AccountQuery the account query
Compliancemandatory This method must be implemented.
MethodgetAccountSearchOrder
Description

Gets an account search order.

Returnosid.financials.AccountSearchOrder the account search order
Compliancemandatory This method must be implemented.
MethodapplyAccountQuery
Description

Applies an account query to this business.

Parametersosid.financials.AccountQueryaccountQuery the account query
ErrorsNULL_ARGUMENT accountQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED accountQuery not of this service
Compliancemandatory This method must be implemented.
MethodinspectAccountQuery
Description

Gets an account query inspector for this business.

Returnosid.financials.AccountQueryInspector the account query inspector
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
Compliancemandatory This method must be implemented.
MethodapplyAccountSequencing
Description

Applies an account search order to this business.

Parametersosid.financials.AccountSearchOrderaccountSearchOrder the account search order
ErrorsNULL_ARGUMENT accountSearchOrder is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED accountSearchOrder not of this service
Compliancemandatory This method must be implemented.
MethodgetAccountQueryFromInspector
Description

Gets an account query from an inspector.

Parametersosid.financials.AccountQueryInspectoraccountQueryInspector a query inspector
Returnosid.financials.AccountQuery the account query
ErrorsNULL_ARGUMENT accountQueryInspector is null
UNSUPPORTED accountQueryInspector is not of this service
Compliancemandatory This method must be implemented.