OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.BusinessSearchSession
Implementsosid.financials.BusinessQuerySession
Description

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

getBusinessesByQuery() is the basic search method and returns a list of Businesses. A more advanced search may be performed with getBusinessesBySearch(). It accepts a BusinessSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getBusinessesBySearch() returns a BusinessSearchResults that can be used to access the resulting BusinessList or be used to perform a search within the result set through Businessesearch.

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.

MethodgetBusinessSearch
Description

Gets a business search.

Returnosid.financials.BusinessSearchthe business search
CompliancemandatoryThis method must be implemented.
MethodgetBusinessSearchOrder
Description

Gets a business search order. The BusinessSearchOrder is supplied to a BusinessSearch to specify the ordering of results.

Returnosid.financials.BusinessSearchOrderthe business search order
CompliancemandatoryThis method must be implemented.
MethodgetBusinessesBySearch
Description

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

Parametersosid.financials.BusinessQuerybusinessQuerythe business query
osid.financials.BusinessSearchbusinessSearchthe business search
Returnosid.financials.BusinessSearchResultsthe business search results
ErrorsNULL_ARGUMENT businessQuery or businessSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED businessQuery or businessSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetBusinessQueryFromInspector
Description

Gets a business query from an inspector. The inspector is available from a BusinessSearchResults.

Parametersosid.financials.BusinessQueryInspectorbusinessQueryInspectora business query inspector
Returnosid.financials.BusinessQuerythe business query
ErrorsNULL_ARGUMENT businessQueryInspector is null
UNSUPPORTED businessQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.