public interface BrokerConstrainerQuerySession extends OsidSession
This session provides methods for searching among
BrokerConstrainer
objects. The search query is constructed using
the BrokerConstrainerQuery.
This session defines views that offer differing behaviors for searching.
Broker constrainer may have a query record indicated by their
respective record types. The query record is accessed via the
BrokerConstrainerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchBrokerConstrainers()
Tests if this user can perform
BrokerConstrainer
lookups. |
BrokerConstrainerQuery |
getBrokerConstrainerQuery()
Gets a broker constrainer query.
|
BrokerConstrainerList |
getBrokerConstrainersByQuery(BrokerConstrainerQuery brokerConstrainerQuery)
Gets a list of
BrokerConstrainers matching the given
search. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
void |
useFederatedDistributorView()
Federates the view for methods in this session.
|
void |
useIsolatedDistributorView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getDistributorId()
Distributor
Id
associated with
this session. Distributor Id
associated with this sessionmandatory
- This method must be implemented. Distributor getDistributor() throws OperationFailedException, PermissionDeniedException
Distributor
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchBrokerConstrainers()
BrokerConstrainer
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. void useFederatedDistributorView()
mandatory
- This method is must be implemented. void useIsolatedDistributorView()
mandatory
- This method is must be implemented. BrokerConstrainerQuery getBrokerConstrainerQuery()
mandatory
- This method must be implemented. BrokerConstrainerList getBrokerConstrainersByQuery(BrokerConstrainerQuery brokerConstrainerQuery) throws OperationFailedException, PermissionDeniedException
BrokerConstrainers
matching the given
search.brokerConstrainerQuery
- the search query BrokerConstrainerList
NullArgumentException
- brokerConstrainerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- brokerConstrainerQuery
is not of this servicemandatory
- This method must be implemented.