| Interface | osid.billing.ItemSearchSession | ||
|---|---|---|---|
| Implements | osid.billing.ItemQuerySession | ||
| Used By | osid.billing.BillingManager | ||
osid.billing.BillingProxyManager | |||
| Description |
This session provides methods for searching among
getItemsByQuery() is the basic search method and
returns a list of Items . A more advanced search
may be performed with getItemsBySearch() . It
accepts an ItemSearch in addition to the query
for the purpose of specifying additional options affecting the
entire search, such as ordering.
getItemsBySearch() returns an
ItemSearchResults that can be used to access the
resulting ItemList or be used to perform a search
within the result set through ItemSearch .
This session defines views that offer differing behaviors for searching.
Items may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
| Method | getItemSearch | ||
| Description |
Gets an item search. | ||
| Return | osid.billing.ItemSearch | the item search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getItemSearchOrder | ||
| Description |
Gets an entry search order. The
| ||
| Return | osid.billing.ItemSearchOrder | the item search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getItemsBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.billing.ItemQuery | itemQuery | the item query |
osid.billing.ItemSearch | itemSearch | the item search | |
| Return | osid.billing.ItemSearchResults | the item search results | |
| Errors | NULL_ARGUMENT | itemQuery or itemSearch is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | itemQuery or itemSearch is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getItemQueryFromInspector | ||
| Description |
Gets an item query from an inspector. The inspector is
available from an | ||
| Parameters | osid.assessment.ItemQueryInspector | itemQueryInspector | an item query inspector |
| Return | osid.billing.ItemQuery | the item query | |
| Errors | NULL_ARGUMENT | itemQueryInspector is null | |
| UNSUPPORTED | itemQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |