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

This session manages queries and sequencing to create "smart" dynamic catalogs. A FiscalPeriodQuery can be retrieved from this session and mapped to this Business to create a virtual collection of FiscalPeriods. The fiscal periods may be sequenced using the FiscalPeriodSearchOrder from this session.

This Business has a default query that matches any fiscal period and a default search order that specifies no sequencing. The queries may be examined using a FiscalPeriodQueryInspector. The query may be modified by converting the inspector back to a FiscalPeriodQuery.

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

Gets a fiscal period query.

Returnosid.financials.FiscalPeriodQuerythe fiscal period query
CompliancemandatoryThis method must be implemented.
MethodgetFiscalPeriodSearchOrder
Description

Gets a fiscal period search order.

Returnosid.financials.FiscalPeriodSearchOrderthe fiscal period search order
CompliancemandatoryThis method must be implemented.
MethodapplyFiscalPeriodQuery
Description

Applies a fiscal period query to this business.

Parametersosid.financials.FiscalPeriodQueryfiscalPeriodQuerythe fiscal period query
ErrorsNULL_ARGUMENT fiscalPeriodQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED fiscalPeriodQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectFiscalPeriodQuery
Description

Gets a fiscal period query inspector for this business.

Returnosid.financials.FiscalPeriodQueryInspectorthe fiscal period query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyFiscalPeriodSequencing
Description

Applies a fiscal period search order to this business.

Parametersosid.financials.FiscalPeriodSearchOrderfiscalPeriodSearchOrderthe fiscal period search order
ErrorsNULL_ARGUMENT fiscalPeriodSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED fiscalPeriodSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetFiscalPeriodQueryFromInspector
Description

Gets a fiscal period query from an inspector.

Parametersosid.financials.FiscalPeriodQueryInspectorfiscalPeriodQueryInspectora query inspector
Returnosid.financials.FiscalPeriodQuerythe fiscal period query
ErrorsNULL_ARGUMENT fiscalPeriodQueryInspector is null
UNSUPPORTED fiscalPeriodQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.