org.osid.billing

Interface BusinessQuerySession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

All Known Subinterfaces:

BusinessSearchSession

public interface BusinessQuerySession
extends OsidSession

This session provides methods for searching among Business objects. 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

Methods

Modifier and Type	Method and 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 org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.