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:
Modifier and Type | Method and 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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupAssessmentBankMappings()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeBankView()
mandatory
- This method is must be implemented. void usePlenaryBankView()
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.mandatory
- This method is must be implemented. IdList getAssessmentIdsByBank(Id bankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Assessment
Ids
associated with a Bank.
bankId
- Id
of the Bank
Ids
NotFoundException
- bankId
is not foundNullArgumentException
- bankId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. AssessmentList getAssessmentsByBank(Id bankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Assessments
associated with a
Bank.
bankId
- Id
of the Bank
NotFoundException
- bankId
is not foundNullArgumentException
- bankId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. IdList getAssessmentIdsByBanks(IdList bankIds) throws OperationFailedException, PermissionDeniedException
Assessment Ids
corresponding to a list
of Banks.
bankIds
- list of bank Ids
Ids
NullArgumentException
- bankIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. AssessmentList getAssessmentsByBanks(IdList bankIds) throws OperationFailedException, PermissionDeniedException
Assessments
corresponding to a list of
Banks.
bankIds
- list of bank Ids
NullArgumentException
- bankIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. IdList getBankIdsByAssessment(Id assessmentId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Bank
Ids
mapped to an
Assessment.
assessmentId
- Id
of an Assessment
Ids
NotFoundException
- assessmentId
is not
foundNullArgumentException
- assessmentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. BankList getBanksByAssessment(Id assessmentId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Banks
mapped to an Assessment.
assessmentId
- Id
of an Assessment
NotFoundException
- assessmentId
is not
foundNullArgumentException
- assessmentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented.