org.osid.financials.posting

Interface PostEntrySearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, PostEntryQuerySession

public interface PostEntrySearchSession
extends PostEntryQuerySession

This session provides methods for searching among PostEntry objects. 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.

Method Summary

Methods

Modifier and Type	Method and Description
PostEntrySearchResults	getPostEntriesBySearch(PostEntryQuery postEntryQuery, PostEntrySearch postEntrySearch) Gets the search results matching the given search query using the given search.
PostEntryQuery	getPostEntryQueryFromInspector(PostEntryQueryInspector postEntryQueryInspector) Gets a post entry query from an inspector.
PostEntrySearch	getPostEntrySearch() Gets a post entry search.
PostEntrySearchOrder	getPostEntrySearchOrder() Gets a post entry search order.

Methods inherited from interface org.osid.financials.posting.PostEntryQuerySession

canSearchPostEntries, getBusiness, getBusinessId, getPostEntriesByQuery, getPostEntryQuery, useFederatedBusinessView, useIsolatedBusinessView

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getPostEntrySearch

PostEntrySearch getPostEntrySearch()

Gets a post entry search.

Returns:

the post entry search

Compliance:

mandatory - This method must be implemented.

getPostEntrySearchOrder

PostEntrySearchOrder getPostEntrySearchOrder()

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

Returns:

the post entry search order

Compliance:

mandatory - This method must be implemented.

getPostEntriesBySearch

PostEntrySearchResults getPostEntriesBySearch(PostEntryQuery postEntryQuery,
                                            PostEntrySearch postEntrySearch)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

postEntryQuery - the post entry query

postEntrySearch - the post entry search

Returns:

the post entry search results

Throws:

NullArgumentException - postEntryQuery or postEntrySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - postEntryQuery or postEntrySearch is not of this service

Compliance:

mandatory - This method must be implemented.

getPostEntryQueryFromInspector

PostEntryQuery getPostEntryQueryFromInspector(PostEntryQueryInspector postEntryQueryInspector)

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

Parameters:

postEntryQueryInspector - a post entry query inspector

Returns:

the post entry query

Throws:

NullArgumentException - postEntryQueryInspector is null

UnsupportedException - postEntryQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.