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:
Modifier and Type | Method and 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
AssessmentOffered Ids 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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupAssessmentOfferedBankMappings()
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()
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.mandatory
- This method is must be implemented. IdList getAssessmentOfferedIdsByBank(Id bankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AssessmentOffered
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. AssessmentOfferedList getAssessmentsOfferedByBank(Id bankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AssessmentOffereds
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 getAssessmentOfferedIdsByBanks(IdList bankIds) throws OperationFailedException, PermissionDeniedException
AssessmentOffered 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. AssessmentOfferedList getAssessmentsOfferedByBanks(IdList bankIds) throws OperationFailedException, PermissionDeniedException
AssessmentOffered
objects
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 getBankIdsByAssessmentOffered(Id assessmentOfferedId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Bank
Ids
mapped to an
AssessmentOffered.
assessmentOfferedId
- Id
of an
AssessmentOffered
Ids
NotFoundException
- assessmentOfferedId
is not foundNullArgumentException
- assessmentOfferedId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. BankList getBanksByAssessmentOffered(Id assessmentOfferedId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Banks
mapped to an
AssessmentOffered.
assessmentOfferedId
- Id
of an
AssessmentOffered
NotFoundException
- assessmentOfferedId
is not foundNullArgumentException
- assessmentOfferedId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented.