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

This session manages queries and sequencing to create "smart" dynamic catalogs. A PostQuery can be retrieved from this session and mapped to this CoursOfferingeCatalog to create a virtual collection of Posts. The posts may be sequenced using the PostSearchOrder from this session.

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

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

Gets a post query.

Returnosid.financials.posting.PostQuerythe post query
CompliancemandatoryThis method must be implemented.
MethodgetPostSearchOrder
Description

Gets a post search order.

Returnosid.financials.posting.PostSearchOrderthe post search order
CompliancemandatoryThis method must be implemented.
MethodapplyPostQuery
Description

Applies a post query to this business.

Parametersosid.financials.posting.PostQuerypostQuerythe post query
ErrorsNULL_ARGUMENT postQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED postQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectPostQuery
Description

Gets a post query inspector for this business.

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

Applies a post search order to this business.

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

Gets a post query from an inspector.

Parametersosid.financials.posting.PostQueryInspectorpostQueryInspectora query inspector
Returnosid.financials.posting.PostQuerythe post query
ErrorsNULL_ARGUMENT postQueryInspector is null
UNSUPPORTED postQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.