OSID Logo
OSID Specifications
financials package
Version 3.1.0
Interfaceosid.financials.BusinessQuerySession
Implementsosid.OsidSession
Implemented Byosid.financials.BusinessSearchSession
Used Byosid.financials.FinancialsManager
osid.financials.FinancialsProxyManager
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.

Returnboolean false if search methods are not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodgetBusinessQuery
Description

Gets a business query.

Returnosid.financials.BusinessQuery the business query
Compliancemandatory This method must be implemented.
MethodgetBusinessesByQuery
Description

Gets a list of Businesses matching the given business query.

Parametersosid.financials.BusinessQuerybusinessQuery the business query
Returnosid.financials.BusinessList the returned BusinessList
ErrorsNULL_ARGUMENT businessQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
UNSUPPORTED businessQuery is not of this service
Compliancemandatory This method must be implemented.