OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.AccountSmartBusinessSession
Implementsosid.OsidSession
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.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.
MethodgetAccountQuery
Description

Gets an account query.

Returnosid.financials.AccountQuerythe account query
CompliancemandatoryThis method must be implemented.
MethodgetAccountSearchOrder
Description

Gets an account search order.

Returnosid.financials.AccountSearchOrderthe account search order
CompliancemandatoryThis method must be implemented.
MethodapplyAccountQuery
Description

Applies an account query to this business.

Parametersosid.financials.AccountQueryaccountQuerythe account query
ErrorsNULL_ARGUMENT accountQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED accountQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectAccountQuery
Description

Gets an account query inspector for this business.

Returnosid.financials.AccountQueryInspectorthe account query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyAccountSequencing
Description

Applies an account search order to this business.

Parametersosid.financials.AccountSearchOrderaccountSearchOrderthe account search order
ErrorsNULL_ARGUMENT accountSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED accountSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAccountQueryFromInspector
Description

Gets an account query from an inspector.

Parametersosid.financials.AccountQueryInspectoraccountQueryInspectora query inspector
Returnosid.financials.AccountQuerythe account query
ErrorsNULL_ARGUMENT accountQueryInspector is null
UNSUPPORTED accountQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.