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

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

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.

MethodgetBusinessId
Description

Gets the Business Id associated with this session.

Returnosid.id.Idthe Business Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBusiness
Description

Gets the Business associated with this session.

Returnosid.billing.Businessthe business
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchItems
Description

Tests if this user can perform Item lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedBusinessView
Description

Federates the view for methods in this session. A federated view will include items in business which are children of this business in the business hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedBusinessView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this business only.

CompliancemandatoryThis method is must be implemented.
MethodgetItemQuery
Description

Gets an item query.

Returnosid.billing.ItemQuerythe item query
CompliancemandatoryThis method must be implemented.
MethodgetItemsByQuery
Description

Gets a list of Items matching the given item query.

Parametersosid.billing.ItemQueryitemQuerythe item query
Returnosid.billing.ItemListthe returned ItemList
ErrorsNULL_ARGUMENT itemQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED itemQuery is not of this service
CompliancemandatoryThis method must be implemented.