OSID Logo
OSID Specifications
financials posting package
Version 3.1.0
Interfaceosid.financials.posting.PostQuerySession
Implementsosid.OsidSession
Implemented Byosid.financials.posting.PostSearchSession
Used Byosid.financials.posting.FinancialsPostingManager
osid.financials.posting.FinancialsPostingProxyManager
Description

This session provides methods for searching among Posts. The search query is constructed using the PostQuery.

This session defines views that offer differing behaviors for searching.

  • federated business view: searches include posts in businesses of which this business is an ancestor in the business hierarchy
  • isolated business view: searches are restricted to posts in this business

Posts may have a query record indicated by their respective query record types. The query record is accessed via the PostQuery.

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

Tests if this user can perform Post lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethoduseFederatedBusinessView
Description

Federates the view for methods in this session. A federated view will include posts in business which are children of this business in the business hierarchy.

Compliancemandatory This method is must be implemented.
MethoduseIsolatedBusinessView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this business only.

Compliancemandatory This method is must be implemented.
MethodgetPostQuery
Description

Gets a post query.

Returnosid.financials.posting.PostQuery the post query.
Compliancemandatory This method must be implemented.
MethodgetPostsByQuery
Description

Gets a list of Posts matching the given post query.

Parametersosid.financials.posting.PostQuerypayerQuery the post query
Returnosid.financials.posting.PostList the returned PostList
ErrorsNULL_ARGUMENT postQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED postQuery is not of this service
Compliancemandatory This method must be implemented.