public interface BankLookupSession extends OsidSession
This session provides methods for retrieving Bank
objects. The Bank
represents a collection of Items
and Assessments.
This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most applications
as it permits operation even if there is data that cannot be accessed. For
example, a browsing application may only need to examine the Banks
it can access, without breaking execution. However, an
administrative application may require all Bank
elements to
be available.
Banks may have an additional records indicated by their respective
record types. The record may not be accessed through a cast of the
Bank.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupBanks()
Tests if this user can perform
Bank lookups. |
Bank |
getBank(Id bankId)
Gets the
Bank specified by its Id. |
BankList |
getBanks()
Gets all
Banks. |
BankList |
getBanksByGenusType(Type bankGenusType)
Gets a
BankList corresponding to the given bank genus
Type which does not include banks of types derived from
the specified Type. |
BankList |
getBanksByIds(IdList bankIds)
Gets a
BankList corresponding to the given
IdList. |
BankList |
getBanksByParentGenusType(Type bankGenusType)
Gets a
BankList corresponding to the given bank genus
Type and include any additional banks with genus types
derived from the specified Type. |
BankList |
getBanksByProvider(Id resourceId)
Gets a
BankList from the given provider . |
BankList |
getBanksByRecordType(Type bankRecordType)
Gets a
BankList containing the given bank record
Type. |
void |
useComparativeBankView()
The returns from the lookup methods may omit or translate elements
based on this session, such as assessment, and not result in an error.
|
void |
usePlenaryBankView()
A complete view of the
Bank returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupBanks()
Bank
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 opt not to offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeBankView()
mandatory
- This method is must be implemented. void usePlenaryBankView()
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. Bank getBank(Id bankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Bank
specified by its Id.
In
plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Bank
may have a different Id
than requested, such as the
case where a duplicate Id
was assigned to a Bank
and retained for compatibility.bankId
- Id
of the Bank
NotFoundException
- bankId
not foundNullArgumentException
- bankId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method is must be implemented. BankList getBanksByIds(IdList bankIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
BankList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
banks specified in the Id
list, in the order of the
list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible Bank
objects may be omitted from the list
and may present the elements in any order including returning a unique
set.bankIds
- the list of Ids
to retrieve Bank
listNotFoundException
- an Id was
not foundNullArgumentException
- bankIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. BankList getBanksByGenusType(Type bankGenusType) throws OperationFailedException, PermissionDeniedException
BankList
corresponding to the given bank genus
Type
which does not include banks of types derived from
the specified Type.
In plenary mode, the returned list
contains all known banks or an error results. Otherwise, the returned
list may contain only those banks that are accessible through this
session.bankGenusType
- a bank genus type Bank
listNullArgumentException
- bankGenusType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. BankList getBanksByParentGenusType(Type bankGenusType) throws OperationFailedException, PermissionDeniedException
BankList
corresponding to the given bank genus
Type
and include any additional banks with genus types
derived from the specified Type.
In plenary mode, the
returned list contains all known banks or an error results. Otherwise,
the returned list may contain only those banks that are accessible
through this session.bankGenusType
- a bank genus type Bank
listNullArgumentException
- bankGenusType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. BankList getBanksByRecordType(Type bankRecordType) throws OperationFailedException, PermissionDeniedException
BankList
containing the given bank record
Type.
In plenary mode, the returned list contains all known
banks or an error results. Otherwise, the returned list may contain
only those banks that are accessible through this session.bankRecordType
- a bank record type Bank
listNullArgumentException
- bankRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. BankList getBanksByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
BankList
from the given provider .
In plenary mode, the returned list contains all known banks or
an error results. Otherwise, the returned list may contain only those
banks that are accessible through this session.resourceId
- a resource Id
Bank
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. BankList getBanks() throws OperationFailedException, PermissionDeniedException
Banks.
In plenary mode, the returned list
contains all known banks or an error results. Otherwise, the returned
list may contain only those banks that are accessible through this
session. BankList
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented.