org.osid.assessment

Interface AssessmentTakenBankSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface AssessmentTakenBankSession
extends OsidSession

This session provides methods to retrieve AssessmentTaken to Bank mappings. An AssessmentTaken 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

Methods

Modifier and Type	Method and Description
boolean	canLookupAssessmentTakenBankMappings() Tests if this user can perform lookups of assessment taken/bank mappings.
AssessmentTakenList	getAssessmentsTakenByBank(Id bankId) Gets the list of AssessmentTakens associated with a Bank.
AssessmentTakenList	getAssessmentsTakenByBanks(IdList bankIds) Gets the list of AssessmentTaken objects corresponding to a list of Banks.
IdList	getAssessmentTakenIdsByBank(Id bankId) Gets the list of AssessmentTaken Ids associated with a Bank.
IdList	getAssessmentTakenIdsByBanks(IdList bankIds) Gets the list of AssessmentTaken Ids corresponding to a list of Banks.
IdList	getBankIdsByAssessmentTaken(Id assessmentTakenId) Gets the list of Bank Ids mapped to an AssessmentTaken.
BankList	getBanksByAssessmentTaken(Id assessmentTakenId) Gets the list of Banks mapped to an AssessmentTaken.
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 AssessmentTaken and Bank returns is desired.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canLookupAssessmentTakenBankMappings

boolean canLookupAssessmentTakenBankMappings()

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

getAssessmentTakenIdsByBank

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

Gets the list of AssessmentTaken Ids associated with a Bank.

Parameters:

bankId - Id of the Bank

Returns:

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

getAssessmentsTakenByBank

AssessmentTakenList getAssessmentsTakenByBank(Id bankId)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Gets the list of AssessmentTakens associated with a Bank.

Parameters:

bankId - Id of the Bank

Returns:

list of related assessments taken

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.

getAssessmentTakenIdsByBanks

IdList getAssessmentTakenIdsByBanks(IdList bankIds)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets the list of AssessmentTaken 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.

getAssessmentsTakenByBanks

AssessmentTakenList getAssessmentsTakenByBanks(IdList bankIds)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

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

Parameters:

bankIds - list of bank Ids

Returns:

list of assessments taken

Throws:

NullArgumentException - bankIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getBankIdsByAssessmentTaken

IdList getBankIdsByAssessmentTaken(Id assessmentTakenId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Gets the list of Bank Ids mapped to an AssessmentTaken.

Parameters:

assessmentTakenId - Id of an AssessmentTaken

Returns:

list of bank Ids

Throws:

NotFoundException - assessmentTakenId is not found

NullArgumentException - assessmentTakenId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getBanksByAssessmentTaken

BankList getBanksByAssessmentTaken(Id assessmentTakenId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Gets the list of Banks mapped to an AssessmentTaken.

Parameters:

assessmentTakenId - Id of an AssessmentTaken

Returns:

list of banks

Throws:

NotFoundException - assessmentTakenId is not found

NullArgumentException - assessmentTakenId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.