OSID Logo
OSID Specifications
financials posting package
Version 3.1.0
Interfaceosid.financials.posting.PostSearchSession
Implementsosid.financials.posting.PostQuerySession
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.

getPostsByQuery() is the basic search method and returns a list of Posts. A more advanced search may be performed with getPostsBySearch(). It accepts a PostSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getPostsBySearch() returns a PostSearchResults that can be used to access the resulting PostList or be used to perform a search within the result set through PostSearch.

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 record types. The queryrecord is accessed via the PostQuery.

MethodgetPostSearch
Description

Gets a post search.

Returnosid.financials.posting.PostSearch the post search
Compliancemandatory This method must be implemented.
MethodgetPostSearchOrder
Description

Gets a post search order. The PostSearchOrder is supplied to a PostSearch to specify the ordering of results.

Returnosid.financials.posting.PostSearchOrder the post search order
Compliancemandatory This method must be implemented.
MethodgetPostsBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.financials.posting.PostQuerypostQuery the post query
osid.financials.posting.PostSearchpostSearch the post search
Returnosid.financials.posting.PostSearchResults the post search results
ErrorsNULL_ARGUMENT postQuery or postSearch is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED postQuery or postSearch is not of this service
Compliancemandatory This method must be implemented.
MethodgetPostQueryFromInspector
Description

Gets a post query from an inspector. The inspector is available from a PostSearchResults.

Parametersosid.assessment.ItemQueryInspectorpostQueryInspector a post query inspector
Returnosid.financials.posting.PostQuery the post query
ErrorsNULL_ARGUMENT postQueryInspector is null
UNSUPPORTED postQueryInspector is not of this service
Compliancemandatory This method must be implemented.