public interface SequenceRuleEnablerQuerySession extends OsidSession
This session provides methods for searching among
SequenceRuleEnabler
objects. The search query is constructed using
the SequenceRuleEnablerQuery.
This session defines views that offer differing behaviors for searching.
sequence rule enablers may have a query record indicated by their
respective record types. The query record is accessed via the
SequenceRuleEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchSequenceRuleEnablers()
Tests if this user can perform
SequenceRuleEnabler
lookups. |
Bank |
getBank()
Gets the
Bank associated with this session. |
Id |
getBankId()
Gets the
Bank Id associated with this
session. |
SequenceRuleEnablerQuery |
getSequenceRuleEnablerQuery()
Gets a sequence rule enabler query.
|
SequenceRuleEnablerList |
getSequenceRuleEnablersByQuery(SequenceRuleEnablerQuery sequenceRuleEnablerQuery)
Gets a list of
SequenceRuleEnablers matching the given
sequence rule enabler query. |
void |
useFederatedBankView()
Federates the view for methods in this session.
|
void |
useIsolatedBankView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBankId()
Bank
Id
associated with this
session. Bank Id
associated with this sessionmandatory
- This method must be implemented. Bank getBank() throws OperationFailedException, PermissionDeniedException
Bank
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchSequenceRuleEnablers()
SequenceRuleEnabler
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 useFederatedBankView()
mandatory
- This method is must be implemented. void useIsolatedBankView()
mandatory
- This method is must be implemented. SequenceRuleEnablerQuery getSequenceRuleEnablerQuery()
mandatory
- This method must be implemented. SequenceRuleEnablerList getSequenceRuleEnablersByQuery(SequenceRuleEnablerQuery sequenceRuleEnablerQuery) throws OperationFailedException, PermissionDeniedException
SequenceRuleEnablers
matching the given
sequence rule enabler query.sequenceRuleEnablerQuery
- the sesequence rule enabler query SequenceRuleEnablerList
NullArgumentException
- sequenceRuleEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- sequenceRuleEnablerQuery
is not of this servicemandatory
- This method must be implemented.