public interface SequenceRuleEnablerBankSession extends OsidSession
This session provides methods to retrieve SequenceRuleEnabler
to Bank
mappings. a SequenceRuleEnabler
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 |
canLookupSequenceRuleEnablerBankMappings()
Tests if this user can perform lookups of sequence rule enabler/bank
mappings.
|
IdList |
getBankIdsBySequenceRuleEnabler(Id sequenceRuleEnablerId)
Gets the
Bank Ids mapped to a
SequenceRuleEnabler. |
BankList |
getBanksBySequenceRuleEnabler(Id sequenceRuleEnablerId)
Gets the
Banks mapped to a SequenceRuleEnabler. |
IdList |
getSequenceRuleEnablerIdsByBank(Id bankId)
Gets the list of
SequenceRuleEnablerIds associated with
an Bank. |
IdList |
getSequenceRuleEnablerIdsByBanks(IdList bankIds)
Gets the list of
SequenceRuleEnabler Ids corresponding
to a list of Banks. |
SequenceRuleEnablerList |
getSequenceRuleEnablersByBank(Id bankId)
Gets the list of sequence rule enablers associated with an
Bank. |
SequenceRuleEnablerList |
getSequenceRuleEnablersByBanks(IdList bankIds)
Gets the list of sequence rule enablers corresponding to a list of
Banks. |
void |
useComparativeSequenceRuleEnablerBankView()
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 |
usePlenarySequenceRuleEnablerBankView()
A complete view of the
SequenceRuleEnabler and
Bank returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupSequenceRuleEnablerBankMappings()
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 useComparativeSequenceRuleEnablerBankView()
mandatory
- This method is must be implemented. void usePlenarySequenceRuleEnablerBankView()
SequenceRuleEnabler
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 getSequenceRuleEnablerIdsByBank(Id bankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
SequenceRuleEnablerIds
associated with
an 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. SequenceRuleEnablerList getSequenceRuleEnablersByBank(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 getSequenceRuleEnablerIdsByBanks(IdList bankIds) throws OperationFailedException, PermissionDeniedException
SequenceRuleEnabler 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. SequenceRuleEnablerList getSequenceRuleEnablersByBanks(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 getBankIdsBySequenceRuleEnabler(Id sequenceRuleEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Bank
Ids
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. BankList getBanksBySequenceRuleEnabler(Id sequenceRuleEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Banks
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.