public interface CommissionEnablerQuerySession extends OsidSession
This session provides methods for searching among
CommissionEnabler
objects. The search query is constructed using
the CommissionEnablerQuery.
This session defines views that offer differing behaviors for searching.
Commission enablers may have a commission enabler query record
indicated by their respective record types. The commission enabler query
record is accessed via the CommissionEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchCommissionEnablers()
Tests if this user can perform
CommissionEnabler
lookups. |
CommissionEnablerQuery |
getCommissionEnablerQuery()
Gets a commission enabler query.
|
CommissionEnablerList |
getCommissionEnablersByQuery(CommissionEnablerQuery commissionEnablerQuery)
Gets a list of
CommissionEnablers matching the given
commission enabler query. |
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
void |
useFederatedFoundryView()
Federates the view for methods in this session.
|
void |
useIsolatedFoundryView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFoundryId()
Foundry
Id
associated with this
session. Foundry Id
associated with this sessionmandatory
- This method must be implemented. Foundry getFoundry() throws OperationFailedException, PermissionDeniedException
Foundry
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchCommissionEnablers()
CommissionEnabler
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 useFederatedFoundryView()
mandatory
- This method is must be implemented. void useIsolatedFoundryView()
mandatory
- This method is must be implemented. CommissionEnablerQuery getCommissionEnablerQuery()
mandatory
- This method must be implemented. CommissionEnablerList getCommissionEnablersByQuery(CommissionEnablerQuery commissionEnablerQuery) throws OperationFailedException, PermissionDeniedException
CommissionEnablers
matching the given
commission enabler query.commissionEnablerQuery
- the commission enabler query CommissionEnablerList
NullArgumentException
- commissionEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- commissionEnablerQuery
is not of this servicemandatory
- This method must be implemented.