public interface SequenceRuleQuerySession extends OsidSession
This session provides methods for searching among SequenceRule
objects. The search query is constructed using the
SequenceRuleQuery.
This session defines views that offer differing behaviors for searching.
sequence rule may have a query record indicated by their respective
record types. The query record is accessed via the
SequenceRuleQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchSequenceRules()
Tests if this user can perform
SequenceRule lookups. |
Bank |
getBank()
Gets the
Bank associated with this session. |
Id |
getBankId()
Gets the
Bank Id associated with this
session. |
SequenceRuleQuery |
getSequenceRuleQuery()
Gets a sequence rule query.
|
SequenceRuleList |
getSequenceRulesByQuery(SequenceRuleQuery sequenceRuleQuery)
Gets a list of
SequenceRules matching the given
sequence rule 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 canSearchSequenceRules()
SequenceRule
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. SequenceRuleQuery getSequenceRuleQuery()
mandatory
- This method must be implemented. SequenceRuleList getSequenceRulesByQuery(SequenceRuleQuery sequenceRuleQuery) throws OperationFailedException, PermissionDeniedException
SequenceRules
matching the given
sequence rule query.sequenceRuleQuery
- the sequence rule query SequenceRuleList
NullArgumentException
- sequenceRuleQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- sequenceRuleQuery
is not of this servicemandatory
- This method must be implemented.