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.
businesses may have a query record indicated by their respective
record types. The query record is accessed via the BusinessQuery.
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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchBusinesses()
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. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. BusinessQuery getBusinessQuery()
mandatory
- This method must be implemented. BusinessList getBusinessesByQuery(BusinessQuery businessQuery) throws OperationFailedException, PermissionDeniedException
Businesses
matching the given business
query.businessQuery
- the business query BusinessList
NullArgumentException
- businessQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- businessQuery
is
not of this servicemandatory
- This method must be implemented.