public interface SequenceRuleBankSession extends OsidSession
This session provides methods to retrieve SequenceRule
to Bank
mappings. a SequenceRule
may appear
in multiple Bank
objects. Each bank may have its own
authorizations governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupSequenceRuleBankMappings()
Tests if this user can perform lookups of sequence rule/bank mappings.
|
IdList |
getBankIdsBySequenceRule(Id sequenceRuleId)
Gets the
Bank Ids mapped to a
SequenceRule. |
BankList |
getBanksBySequenceRule(Id sequenceRuleId)
Gets the
Banks mapped to a SequenceRule. |
IdList |
getSequenceRuleIdsByBank(Id bankId)
Gets the list of
SequenceRuleIds associated with a
Bank. |
IdList |
getSequenceRuleIdsByBanks(IdList bankIds)
Gets the list of
SequenceRule Ids corresponding to a
list of Banks. |
SequenceRuleList |
getSequenceRulesByBank(Id bankId)
Gets the list of sequence rule associated with a
Bank. |
SequenceRuleList |
getSequenceRulesByBanks(IdList bankIds)
Gets the list of sequence rule corresponding to a list of
Banks. |
void |
useComparativeSequenceRuleBankView()
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 |
usePlenarySequenceRuleBankView()
A complete view of the
SequenceRule and Bank
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupSequenceRuleBankMappings()
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 useComparativeSequenceRuleBankView()
mandatory
- This method is must be implemented. void usePlenarySequenceRuleBankView()
SequenceRule
and Bank
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. IdList getSequenceRuleIdsByBank(Id bankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SequenceRuleIds
associated with a
Bank.
bankId
- Id
of the Bank
Ids
NotFoundException
- bankId
is not foundNullArgumentException
- bankId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SequenceRuleList getSequenceRulesByBank(Id bankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Bank.
bankId
- Id
of the Bank
NotFoundException
- bankId
is not foundNullArgumentException
- bankId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getSequenceRuleIdsByBanks(IdList bankIds) throws OperationFailedException, PermissionDeniedException
SequenceRule Ids
corresponding to a
list of Banks.
bankIds
- list of bank Ids
Ids
NullArgumentException
- bankIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. SequenceRuleList getSequenceRulesByBanks(IdList bankIds) throws OperationFailedException, PermissionDeniedException
Banks.
bankIds
- list of bank Ids
NullArgumentException
- bankIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getBankIdsBySequenceRule(Id sequenceRuleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Bank
Ids
mapped to a
SequenceRule.
sequenceRuleId
- Id
of a SequenceRule
NotFoundException
- sequenceRuleId
is
not foundNullArgumentException
- sequenceRuleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BankList getBanksBySequenceRule(Id sequenceRuleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Banks
mapped to a SequenceRule.
sequenceRuleId
- Id
of a SequenceRule
NotFoundException
- sequenceRuleId
is
not foundNullArgumentException
- sequenceRuleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.