OSID Logo
OSID Specifications
financials posting package
Version 3.1.0
Interfaceosid.financials.posting.PostEntrySearchSession
Implementsosid.financials.posting.PostEntryQuerySession
Used Byosid.financials.posting.FinancialsPostingManager
osid.financials.posting.FinancialsPostingProxyManager
Description

This session provides methods for searching among PostEntries. The search query is constructed using the PostEntryQuery.

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

This session defines views that offer differing behaviors for searching.

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

Post entries may have a query record indicated by their respective record types. The query record is accessed via the PostEntryQuery.

MethodgetPostEntrySearch
Description

Gets a post entry search.

Returnosid.financials.posting.PostEntrySearch the post entry search
Compliancemandatory This method must be implemented.
MethodgetPostEntrySearchOrder
Description

Gets a post entry search order. The PostEntrySearchOrder is supplied to a PostEntrySearch to specify the ordering of results.

Returnosid.financials.posting.PostEntrySearchOrder the post entry search order
Compliancemandatory This method must be implemented.
MethodgetPostEntriesBySearch
Description

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

Parametersosid.financials.posting.PostEntryQuerypostEntryQuery the post entry query
osid.financials.posting.PostEntrySearchpostEntrySearch the post entry search
Returnosid.financials.posting.PostEntrySearchResults the post entry search results
ErrorsNULL_ARGUMENT postEntryQuery or postEntrySearch is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED postEntryQuery or postEntrySearch is not of this service
Compliancemandatory This method must be implemented.
MethodgetPostEntryQueryFromInspector
Description

Gets a post entry query from an inspector. The inspector is available from a PostEntrySearchResults.

Parametersosid.financials.posting.PostEntryQueryInspectorpostEntryQueryInspector a post entry query inspector
Returnosid.financials.posting.PostEntryQuery the post entry query
ErrorsNULL_ARGUMENT postEntryQueryInspector is null
UNSUPPORTED postEntryQueryInspector is not of this service
Compliancemandatory This method must be implemented.