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

This session manages queries and sequencing to create "smart" dynamic catalogs. A PostEntryQuery can be retrieved from this session and mapped to this Business to create a virtual collection of PostEntries. The post entries may be sequenced using the PostEntrySearchOrder from this session.

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

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

Gets a post entry query.

Returnosid.financials.posting.PostEntryQuerythe post entry query
CompliancemandatoryThis method must be implemented.
MethodgetPostEntrySearchOrder
Description

Gets a post entry search order.

Returnosid.financials.posting.PostEntrySearchOrderthe post entry search order
CompliancemandatoryThis method must be implemented.
MethodapplyPostEntryQuery
Description

Applies a post entry query to this business.

Parametersosid.financials.posting.PostEntryQuerypostEntryQuerythe post entry query
ErrorsNULL_ARGUMENT postEntryQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED postEntryQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectPostEntryQuery
Description

Gets a post entry query inspector for this business.

Returnosid.financials.posting.PostEntryQueryInspectorthe post entry query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyPostEntrySequencing
Description

Applies a post entry search order to this business.

Parametersosid.financials.posting.PostEntrySearchOrderpostEntrySearchOrderthe post entry search order
ErrorsNULL_ARGUMENT postEntrySearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED postEntrySearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPostEntryQueryFromInspector
Description

Gets a post entry query from an inspector.

Parametersosid.financials.posting.PostEntryQueryInspectorpostEntryQueryInspectora query inspector
Returnosid.financials.posting.PostEntryQuerythe post entry query
ErrorsNULL_ARGUMENT postEntryQueryInspector is null
UNSUPPORTED postEntryQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.