Interface ItemBankSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ItemBankSession
extends OsidSession

This session provides methods to retrieve Item to Bank mappings. An Item may appear in multiple Banks. Each Bank may have its own authorizations governing who is allowed to look at it.

This lookup session defines two views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Modifier and Type	Method	Description
boolean	canLookupItemBankMappings()	Tests if this user can perform lookups of item/bank mappings.
IdList	getBankIdsByItem(Id itemId)	Gets the list of Bank Ids mapped to an Item.
BankList	getBanksByItem(Id itemId)	Gets the list of Banks mapped to an Item.
IdList	getItemIdsByBank(Id bankId)	Gets the list of Item Ids associated with a Bank.
IdList	getItemIdsByBanks(IdList bankIds)	Gets the list of Item Ids corresponding to a list of Banks.
ItemList	getItemsByBank(Id bankId)	Gets the list of Items associated with a Bank.
ItemList	getItemsByBanks(IdList bankIds)	Gets the list of Items corresponding to a list of Banks.
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 Item and Bank returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canLookupItemBankMappings

boolean canLookupItemBankMappings()

Tests if this user can perform lookups of item/bank mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeBankView

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. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryBankView

void usePlenaryBankView()

A complete view of the Item 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.

Compliance:

mandatory - This method is must be implemented.

getItemIdsByBank

IdList getItemIdsByBank(Id bankId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Item Ids associated with a Bank.

Parameters:

bankId - Id of the Bank

Returns:

list of related item Ids

Throws:

NotFoundException - bankId is not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getItemsByBank

ItemList getItemsByBank(Id bankId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Items associated with a Bank.

Parameters:

bankId - Id of the Bank

Returns:

list of related items

Throws:

NotFoundException - bankId is not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getItemIdsByBanks

IdList getItemIdsByBanks(IdList bankIds)
                  throws OperationFailedException,
PermissionDeniedException

Gets the list of Item Ids corresponding to a list of Banks.

Parameters:

bankIds - list of bank Ids

Returns:

list of bank Ids

Throws:

NullArgumentException - bankIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - assessment failure

Compliance:

mandatory - This method must be implemented.

getItemsByBanks

ItemList getItemsByBanks(IdList bankIds)
                  throws OperationFailedException,
PermissionDeniedException

Gets the list of Items corresponding to a list of Banks.

Parameters:

bankIds - list of bank Ids

Returns:

list of items

Throws:

NullArgumentException - bankIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - assessment failure

Compliance:

mandatory - This method must be implemented.

getBankIdsByItem

IdList getBankIdsByItem(Id itemId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Bank Ids mapped to an Item.

Parameters:

itemId - Id of an Item

Returns:

list of bank Ids

Throws:

NotFoundException - itemId is not found

NullArgumentException - itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - assessment failure

Compliance:

mandatory - This method must be implemented.

getBanksByItem

BankList getBanksByItem(Id itemId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Banks mapped to an Item.

Parameters:

itemId - Id of an Item

Returns:

list of banks

Throws:

NotFoundException - itemId is not found

NullArgumentException - itemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - assessment failure

Compliance:

mandatory - This method must be implemented.