OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.ItemSearchSession
Implementsosid.billing.ItemQuerySession
Description

This session provides methods for searching among Item objects. The search query is constructed using the ItemQuery.

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.

  • federated business view: searches include items in businesses of which this business is an ancestor in the business hierarchy
  • isolated business view: searches are restricted to items in this business

Items may have a query record indicated by their respective record types. The query record is accessed via the ItemQuery.

MethodgetItemSearch
Description

Gets an item search.

Returnosid.billing.ItemSearchthe item search
CompliancemandatoryThis method must be implemented.
MethodgetItemSearchOrder
Description

Gets an entry search order. The ItemSearchOrder is supplied to an ItemSearch to specify the ordering of results.

Returnosid.billing.ItemSearchOrderthe item search order
CompliancemandatoryThis method must be implemented.
MethodgetItemsBySearch
Description

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

Parametersosid.billing.ItemQueryitemQuerythe item query
osid.billing.ItemSearchitemSearchthe item search
Returnosid.billing.ItemSearchResultsthe item search results
ErrorsNULL_ARGUMENT itemQuery or itemSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED itemQuery or itemSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetItemQueryFromInspector
Description

Gets an item query from an inspector. The inspector is available from an ItemSearchResults.

Parametersosid.assessment.ItemQueryInspectoritemQueryInspectoran item query inspector
Returnosid.billing.ItemQuerythe item query
ErrorsNULL_ARGUMENT itemQueryInspector is null
UNSUPPORTED itemQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.