Interface AssessmentBankSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AssessmentBankSession
extends OsidSession

This session provides methods to retrieve Assessment to Bank mappings. An Assessment 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	canLookupAssessmentBankMappings()	Tests if this user can perform lookups of assessment/bank mappings.
IdList	getAssessmentIdsByBank(Id bankId)	Gets the list of Assessment Ids associated with a Bank .
IdList	getAssessmentIdsByBanks(IdList bankIds)	Gets the list of Assessment Ids corresponding to a list of Banks .
AssessmentList	getAssessmentsByBank(Id bankId)	Gets the list of Assessments associated with a Bank .
AssessmentList	getAssessmentsByBanks(IdList bankIds)	Gets the list of Assessments corresponding to a list of Banks .
IdList	getBankIdsByAssessment(Id assessmentId)	Gets the list of Bank Ids mapped to an Assessment .
BankList	getBanksByAssessment(Id assessmentId)	Gets the list of Banks mapped to an Assessment .
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 Assessment 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

canLookupAssessmentBankMappings

boolean canLookupAssessmentBankMappings()

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

getAssessmentIdsByBank

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

Gets the list of Assessment Ids associated with a Bank .

Parameters:

bankId - Id of the Bank

Returns:

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

getAssessmentsByBank

AssessmentList getAssessmentsByBank(Id bankId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Assessments associated with a Bank .

Parameters:

bankId - Id of the Bank

Returns:

list of related assessments

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.

getAssessmentIdsByBanks

IdList getAssessmentIdsByBanks(IdList bankIds)
                        throws OperationFailedException,
PermissionDeniedException

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

Compliance:

mandatory - This method must be implemented.

getAssessmentsByBanks

AssessmentList getAssessmentsByBanks(IdList bankIds)
                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

bankIds - list of bank Ids

Returns:

list of assessments

Throws:

NullArgumentException - bankIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getBankIdsByAssessment

IdList getBankIdsByAssessment(Id assessmentId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Bank Ids mapped to an Assessment .

Parameters:

assessmentId - Id of an Assessment

Returns:

list of bank Ids

Throws:

NotFoundException - assessmentId is not found

NullArgumentException - assessmentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getBanksByAssessment

BankList getBanksByAssessment(Id assessmentId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Banks mapped to an Assessment .

Parameters:

assessmentId - Id of an Assessment

Returns:

list of banks

Throws:

NotFoundException - assessmentId is not found

NullArgumentException - assessmentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.