public interface SequenceRuleEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve SequenceRuleEnabler
to SequenceRule
mappings. a Step
with multiple SequenceRuleEnablers
means any positive rule
evaluation across the enablers result in an effective SequenceRule.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupSequenceRuleEnablerRules()
Tests if this user can perform lookups of sequence rule
enabler/sequence rule mappings.
|
Bank |
getBank()
Gets the
Bank associated with this session. |
Id |
getBankId()
Gets the
Bank Id associated with this
session. |
IdList |
getSequenceRuleEnablerIdsForSequenceRule(Id sequenceRuleId)
Gets the
SequenceRuleEnabler Id associated with a
SequenceRule. |
SequenceRuleEnablerList |
getSequenceRuleEnablersForSequenceRule(Id sequenceRuleId)
Gets the
SequenceRuleEnablers associated with a
SequenceRule. |
IdList |
getSequenceRuleIdsForSequenceRuleEnabler(Id sequenceRuleEnablerId)
Gets the
SequenceRule Ids mapped to a
SequenceRuleEnabler. |
SequenceRuleList |
getSequenceRulesForSequenceRuleEnabler(Id sequenceRuleEnablerId)
Gets the
SequenceRules mapped to a
SequenceRuleEnabler. |
void |
useComparativeSequenceRuleEnablerRuleView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedBankView()
Federates the view for methods in this session.
|
void |
useIsolatedBankView()
Isolates the view for methods in this session.
|
void |
usePlenarySequenceRuleEnablerRuleView()
A complete view of the
SequenceRuleEnabler and
SequenceRule returns is desired. |
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 canLookupSequenceRuleEnablerRules()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer lookup operations to
unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeSequenceRuleEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenarySequenceRuleEnablerRuleView()
SequenceRuleEnabler
and
SequenceRule
returns is desired. Methods will return what is
requested or result in an error. This view is used when greater
precision is desired at the expense of interoperability.mandatory
- This method is must be implemented. void useFederatedBankView()
mandatory
- This method is must be implemented. void useIsolatedBankView()
mandatory
- This method is must be implemented. IdList getSequenceRuleEnablerIdsForSequenceRule(Id sequenceRuleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SequenceRuleEnabler Id
associated with a
SequenceRule.
sequenceRuleId
- Id
of the SequenceRule
Ids
NotFoundException
- sequenceRuleId
is
not foundNullArgumentException
- sequenceRuleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SequenceRuleEnablerList getSequenceRuleEnablersForSequenceRule(Id sequenceRuleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SequenceRuleEnablers
associated with a
SequenceRule.
sequenceRuleId
- Id
of the SequenceRule
NotFoundException
- sequenceRuleId
is
not foundNullArgumentException
- sequenceRuleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getSequenceRuleIdsForSequenceRuleEnabler(Id sequenceRuleEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SequenceRule
Ids
mapped to a
SequenceRuleEnabler.
sequenceRuleEnablerId
- Id
of a
SequenceRuleEnabler
Ids
NotFoundException
- sequenceRuleEnablerId
is not foundNullArgumentException
- sequenceRuleEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SequenceRuleList getSequenceRulesForSequenceRuleEnabler(Id sequenceRuleEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SequenceRules
mapped to a
SequenceRuleEnabler.
sequenceRuleEnablerId
- Id
of a
SequenceRuleEnabler
NotFoundException
- sequenceRuleEnablerId
is not foundNullArgumentException
- sequenceRuleEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.