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