public interface SequenceRuleSmartBankSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
bank. a SequenceRuleQuery
can be retrieved from this
session and mapped to this Bank
to create a virtual
collection of sequence rules. The sequence rule may be sequenced using the
SequenceRuleSearchOrder
from this session.
This Bank
has a default query that matches any sequence
rule and a default search order that specifies no sequencing. The queries
may be examined using a SequenceRuleQueryInspector.
The
query may be modified by converting the inspector back to a
SequenceRuleQuery.
Modifier and Type | Method and Description |
---|---|
void |
applySequenceRuleQuery(SequenceRuleQuery sequenceRuleQuery)
Applies a sequence rule query to this bank.
|
void |
applySequenceRuleSequencing(SequenceRuleSearchOrder sequenceRuleSearchOrder)
Applies a sequence rule search order to this bank.
|
boolean |
canManageSmartBanks()
Tests if this user can manage smart bank.
|
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.
|
SequenceRuleQuery |
getSequenceRuleQueryFromInspector(SequenceRuleQueryInspector sequenceRuleQueryInspector)
Gets a sequence rule query from an inspector.
|
SequenceRuleSearchOrder |
getSequenceRuleSearchOrder()
Gets a sequence rule search order.
|
SequenceRuleQueryInspector |
inspectSequenceRuleQuery()
Gets a sequence rule query inspector for this bank.
|
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 canManageSmartBanks()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart bank management is not
authorized, true
otherwisemandatory
- This method must be implemented. SequenceRuleQuery getSequenceRuleQuery()
mandatory
- This method must be implemented. SequenceRuleSearchOrder getSequenceRuleSearchOrder()
mandatory
- This method must be implemented. void applySequenceRuleQuery(SequenceRuleQuery sequenceRuleQuery) throws OperationFailedException, PermissionDeniedException
sequenceRuleQuery
- the sequence rule queryNullArgumentException
- sequenceRuleQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- sequenceRuleQuery
not of this servicemandatory
- This method must be implemented. SequenceRuleQueryInspector inspectSequenceRuleQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applySequenceRuleSequencing(SequenceRuleSearchOrder sequenceRuleSearchOrder) throws OperationFailedException, PermissionDeniedException
sequenceRuleSearchOrder
- the sequence rule search orderNullArgumentException
- sequenceRuleSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- sequenceRuleSearchOrder
not of this servicemandatory
- This method must be implemented. SequenceRuleQuery getSequenceRuleQueryFromInspector(SequenceRuleQueryInspector sequenceRuleQueryInspector)
sequenceRuleQueryInspector
- a sequence rule query inspectorNullArgumentException
-
sequenceRuleQueryInspector
is null
UnsupportedException
-
sequenceRuleQueryInspector
is not of this servicemandatory
- This method must be implemented.