OSID Logo
OSID Specifications
billing package
Version 3.0.0
Interfaceosid.billing.BusinessQuerySession
Implementsosid.OsidSession
Implemented Byosid.billing.BusinessSearchSession
Used Byosid.billing.BillingManager
osid.billing.BillingProxyManager
Description

This session provides methods for searching among Businesses . The search query is constructed using the BusinessQuery .

This session defines views that offer differing behaviors for searching.

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

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

MethodcanSearchBusinesses
Description

Tests if this user can perform Business 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.

Returnbooleanfalse if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBusinessQuery
Description

Gets a business query.

Returnosid.billing.BusinessQuerythe business query
CompliancemandatoryThis method must be implemented.
MethodgetBusinessesByQuery
Description

Gets a list of Businesses matching the given business query.

Parametersosid.billing.BusinessQuerybusinessQuerythe business query
Returnosid.billing.BusinessListthe returned BusinessList
ErrorsNULL_ARGUMENTbusinessQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDbusinessQuery is not of this service
CompliancemandatoryThis method must be implemented.