Interface AssessmentPartBankSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AssessmentPartBankSession
extends OsidSession

This session provides methods to retrieve AssessmentPart to Bank mappings. an AssessmentPart 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:

• 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	canLookupAssessmentPartBankMappings()	Tests if this user can perform lookups of assessment part/bank mappings.
IdList	getAssessmentPartIdsByBank(Id bankId)	Gets the list of AssessmentPartIds associated with an Bank .
IdList	getAssessmentPartIdsByBanks(IdList bankIds)	Gets the list of AssessmentPartIds corresponding to a list of Banks .
AssessmentPartList	getAssessmentPartsByBank(Id bankId)	Gets the list of assessment parts associated with an Bank .
AssessmentPartList	getAssessmentPartsByBanks(IdList bankIds)	Gets the list of assessment part corresponding to a list of Banks .
IdList	getBankIdsByAssessmentPart(Id assessmentPartId)	Gets the Bank Ids mapped to an AssessmentPart .
BankList	getBanksByAssessmentPart(Id assessmentPartId)	Gets the Banks mapped to an AssessmentPart .
void	useComparativeAssessmentPartBankView()	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	usePlenaryAssessmentPartBankView()	A complete view of the AssessmentPart 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

canLookupAssessmentPartBankMappings

boolean canLookupAssessmentPartBankMappings()

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

useComparativeAssessmentPartBankView

void useComparativeAssessmentPartBankView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, 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.

usePlenaryAssessmentPartBankView

void usePlenaryAssessmentPartBankView()

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

getAssessmentPartIdsByBank

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

Gets the list of AssessmentPartIds associated with an Bank .

Parameters:

bankId - Id of the Bank

Returns:

list of related assessment part Ids

Throws:

NotFoundException - bankId is not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAssessmentPartsByBank

AssessmentPartList getAssessmentPartsByBank(Id bankId)
                                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of assessment parts associated with an Bank .

Parameters:

bankId - Id of the Bank

Returns:

list of related assessment parts

Throws:

NotFoundException - bankId is not found

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAssessmentPartIdsByBanks

IdList getAssessmentPartIdsByBanks(IdList bankIds)
                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

bankIds - list of bank Ids

Returns:

list of assessment part Ids

Throws:

NullArgumentException - bankIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAssessmentPartsByBanks

AssessmentPartList getAssessmentPartsByBanks(IdList bankIds)
                                      throws OperationFailedException,
PermissionDeniedException

Gets the list of assessment part corresponding to a list of Banks .

Parameters:

bankIds - list of bank Ids

Returns:

list of assessment parts

Throws:

NullArgumentException - bankIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBankIdsByAssessmentPart

IdList getBankIdsByAssessmentPart(Id assessmentPartId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Bank Ids mapped to an AssessmentPart .

Parameters:

assessmentPartId - Id of an AssessmentPart

Returns:

list of banks

Throws:

NotFoundException - assessmentPartId is not found

NullArgumentException - assessmentPartId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getBanksByAssessmentPart

BankList getBanksByAssessmentPart(Id assessmentPartId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Banks mapped to an AssessmentPart .

Parameters:

assessmentPartId - Id of an AssessmentPart

Returns:

list of banks

Throws:

NotFoundException - assessmentPartId is not found

NullArgumentException - assessmentPartId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.