Interface AssessmentOfferedBankSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AssessmentOfferedBankSession
extends OsidSession

This session provides methods to retrieve AssessmentOffered to Bank mappings. An AssessmentOffered 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	canLookupAssessmentOfferedBankMappings()	Tests if this user can perform lookups of assessment offered/bank mappings.
IdList	getAssessmentOfferedIdsByBank(Id bankId)	Gets the list of AssessmentOffered Ids associated with a Bank.
IdList	getAssessmentOfferedIdsByBanks(IdList bankIds)	Gets the list of AssessmentOfferedIds corresponding to a list of Banks.
AssessmentOfferedList	getAssessmentsOfferedByBank(Id bankId)	Gets the list of AssessmentOffereds associated with a Bank.
AssessmentOfferedList	getAssessmentsOfferedByBanks(IdList bankIds)	Gets the list of AssessmentOffered objects corresponding to a list of Banks.
IdList	getBankIdsByAssessmentOffered(Id assessmentOfferedId)	Gets the list of Bank Ids mapped to an AssessmentOffered.
BankList	getBanksByAssessmentOffered(Id assessmentOfferedId)	Gets the list of Banks mapped to an AssessmentOffered.
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 AssessmentOffered 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

canLookupAssessmentOfferedBankMappings

boolean canLookupAssessmentOfferedBankMappings()

Tests if this user can perform lookups of assessment offered/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 AssessmentOffered 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.

getAssessmentOfferedIdsByBank

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

Gets the list of AssessmentOffered Ids associated with a Bank.

Parameters:

bankId - Id of the Bank

Returns:

list of related assessment offered 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.

getAssessmentsOfferedByBank

AssessmentOfferedList getAssessmentsOfferedByBank(Id bankId)
                                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of AssessmentOffereds associated with a Bank.

Parameters:

bankId - Id of the Bank

Returns:

list of related assessments offered

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.

getAssessmentOfferedIdsByBanks

IdList getAssessmentOfferedIdsByBanks(IdList bankIds)
                               throws OperationFailedException,
PermissionDeniedException

Gets the list of AssessmentOfferedIds 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 - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getAssessmentsOfferedByBanks

AssessmentOfferedList getAssessmentsOfferedByBanks(IdList bankIds)
                                            throws OperationFailedException,
PermissionDeniedException

Gets the list of AssessmentOffered objects corresponding to a list of Banks.

Parameters:

bankIds - list of bank Ids

Returns:

list of assessments offered

Throws:

NullArgumentException - bankIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getBankIdsByAssessmentOffered

IdList getBankIdsByAssessmentOffered(Id assessmentOfferedId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Bank Ids mapped to an AssessmentOffered.

Parameters:

assessmentOfferedId - Id of an AssessmentOffered

Returns:

list of bank Ids

Throws:

NotFoundException - assessmentOfferedId is not found

NullArgumentException - assessmentOfferedId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getBanksByAssessmentOffered

BankList getBanksByAssessmentOffered(Id assessmentOfferedId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Banks mapped to an AssessmentOffered.

Parameters:

assessmentOfferedId - Id of an AssessmentOffered

Returns:

list of banks

Throws:

NotFoundException - assessmentOfferedId is not found

NullArgumentException - assessmentOfferedId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.