| Interface | osid.financials.posting.PostQuerySession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Posts may have a query record indicated by their
respective query record types. The query record is accessed
via the | ||
| Method | getBusinessId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the Business Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getBusiness | ||
| Description |
Gets the | ||
| Return | osid.financials.Business | the business | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canSearchPosts | ||
| Description |
Tests if this user can perform | ||
| Return | boolean | false if search methods are not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | useFederatedBusinessView | ||
| Description |
Federates the view for methods in this session. A federated view will include posts in business which are children of this business in the business hierarchy. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | useIsolatedBusinessView | ||
| Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this business only. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | getPostQuery | ||
| Description |
Gets a post query. | ||
| Return | osid.financials.posting.PostQuery | the post query. | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPostsByQuery | ||
| Description |
Gets a list of | ||
| Parameters | osid.financials.posting.PostQuery | payerQuery | the post query |
| Return | osid.financials.posting.PostList | the returned PostList | |
| Errors | NULL_ARGUMENT | postQuery is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | postQuery is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |