| Interface | osid.financials.posting.PostEntrySearchSession | ||
|---|---|---|---|
| Implements | osid.financials.posting.PostEntryQuerySession | ||
| Used By | osid.financials.posting.FinancialsPostingManager | ||
osid.financials.posting.FinancialsPostingProxyManager | |||
| Description |
This session provides methods for searching among
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.
Post entries may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
| Method | getPostEntrySearch | ||
| Description |
Gets a post entry search. | ||
| Return | osid.financials.posting.PostEntrySearch | the post entry search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPostEntrySearchOrder | ||
| Description |
Gets a post entry search order. The
| ||
| Return | osid.financials.posting.PostEntrySearchOrder | the post entry search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPostEntriesBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.financials.posting.PostEntryQuery | postEntryQuery | the post entry query |
osid.financials.posting.PostEntrySearch | postEntrySearch | the post entry search | |
| Return | osid.financials.posting.PostEntrySearchResults | the post entry search results | |
| Errors | NULL_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 | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getPostEntryQueryFromInspector | ||
| Description |
Gets a post entry query from an inspector. The
inspector is available from a
| ||
| Parameters | osid.financials.posting.PostEntryQueryInspector | postEntryQueryInspector | a post entry query inspector |
| Return | osid.financials.posting.PostEntryQuery | the post entry query | |
| Errors | NULL_ARGUMENT | postEntryQueryInspector is null | |
| UNSUPPORTED | postEntryQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |