Interface BusinessQuerySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

BusinessSearchSession

public interface BusinessQuerySession
extends OsidSession

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.

Method Summary

Modifier and Type	Method	Description
boolean	canSearchBusinesses()	Tests if this user can perform Business lookups.
BusinessList	getBusinessesByQuery(BusinessQuery businessQuery)	Gets a list of Businesses matching the given business query.
BusinessQuery	getBusinessQuery()	Gets a business query.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canSearchBusinesses

boolean canSearchBusinesses()

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.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getBusinessQuery

BusinessQuery getBusinessQuery()

Gets a business query.

Returns:

the business query

Compliance:

mandatory - This method must be implemented.

getBusinessesByQuery

BusinessList getBusinessesByQuery(BusinessQuery businessQuery)
                           throws OperationFailedException,
PermissionDeniedException

Gets a list of Businesses matching the given business query.

Parameters:

businessQuery - the business query

Returns:

the returned BusinessList

Throws:

NullArgumentException - businessQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - businessQuery is not of this service

Compliance:

mandatory - This method must be implemented.