public interface PoolQuerySession extends OsidSession
This session provides methods for searching among Pool
objects. The search query is constructed using the PoolQuery.
This session defines views that offer differing behaviors for searching.
Pools may have a query record indicated by their respective record
types. The query record is accessed via the PoolQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchPools()
Tests if this user can perform
Pool lookups. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
PoolQuery |
getPoolQuery()
Gets a pool query.
|
PoolList |
getPoolsByQuery(PoolQuery poolQuery)
Gets a list of
Pools matching the given pool query. |
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 canSearchPools()
Pool
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. PoolQuery getPoolQuery()
mandatory
- This method must be implemented. PoolList getPoolsByQuery(PoolQuery poolQuery) throws OperationFailedException, PermissionDeniedException
Pools
matching the given pool query.poolQuery
- the pool query PoolList
NullArgumentException
- poolQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- poolQuery
is not
of this servicemandatory
- This method must be implemented.