| Interface | osid.financials.posting.PostSearchSession | ||
|---|---|---|---|
| Implements | osid.financials.posting.PostQuerySession | ||
| Used By | osid.financials.posting.FinancialsPostingManager | ||
osid.financials.posting.FinancialsPostingProxyManager | |||
| Description |
This session provides methods for searching among
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.
Posts may have a query record indicated by their
respective record types. The queryrecord is accessed via the
| ||
| Method | getPostSearch | ||
| Description |
Gets a post search. | ||
| Return | osid.financials.posting.PostSearch | the post search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPostSearchOrder | ||
| Description |
Gets a post search order. The
| ||
| Return | osid.financials.posting.PostSearchOrder | the post search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPostsBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.financials.posting.PostQuery | postQuery | the post query |
osid.financials.posting.PostSearch | postSearch | the post search | |
| Return | osid.financials.posting.PostSearchResults | the post search results | |
| Errors | NULL_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 | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getPostQueryFromInspector | ||
| Description |
Gets a post query from an inspector. The inspector is
available from a | ||
| Parameters | osid.assessment.ItemQueryInspector | postQueryInspector | a post query inspector |
| Return | osid.financials.posting.PostQuery | the post query | |
| Errors | NULL_ARGUMENT | postQueryInspector is null | |
| UNSUPPORTED | postQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |