Interface AssessmentBankSession
- All Superinterfaces:
AutoCloseable, Closeable, OsidSession, 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 TypeMethodDescriptionbooleanTests if this user can perform lookups of assessment/bank mappings.getAssessmentIdsByBank(Id bankId) Gets the list ofAssessmentIdsassociated with aBank.getAssessmentIdsByBanks(IdList bankIds) Gets the list ofAssessment Idscorresponding to a list ofBanks.getAssessmentsByBank(Id bankId) Gets the list ofAssessmentsassociated with aBank.getAssessmentsByBanks(IdList bankIds) Gets the list ofAssessmentscorresponding to a list ofBanks.getBankIdsByAssessment(Id assessmentId) Gets the list ofBankIdsmapped to anAssessment.getBanksByAssessment(Id assessmentId) Gets the list ofBanksmapped to anAssessment.voidThe returns from the lookup methods may omit or translate elements based on this session, such as assessment, and not result in an error.voidA complete view of theAssessmentandBankreturns is desired.Methods inherited from interface OsidSession
closeMethods inherited from interface OsidSession
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactionsModifier and TypeMethodDescriptionGets the agent authenticated to this session.Gets theIdof the agent authenticated to this session.Gets the rate of the service clock.getDate()Gets the service date which may be the current date or the effective date in which this session exists.Gets the effective agent in use by this session.Gets theIdof the effective agent in use by this session.Gets theDisplayTextformatTypepreference in effect for this session.Gets the locale indicating the localization preferences in effect for this session.booleanTests if an agent is authenticated to this session.Starts a new transaction for this sesson.booleanTests 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 aPERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.- Returns:
falseif looking up mappings is not authorized,trueotherwise- 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 theAssessmentandBankreturns 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 ofAssessmentIdsassociated with aBank.- Parameters:
bankId-Idof theBank- Returns:
- list of related assessment
Ids - Throws:
NotFoundException-bankIdis not foundNullArgumentException-bankIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure occurred- Compliance:
mandatory- This method must be implemented.
-
getAssessmentsByBank
AssessmentList getAssessmentsByBank(Id bankId) throws NotFoundException, OperationFailedException, PermissionDeniedException Gets the list ofAssessmentsassociated with aBank.- Parameters:
bankId-Idof theBank- Returns:
- list of related assessments
- Throws:
NotFoundException-bankIdis not foundNullArgumentException-bankIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure occurred- Compliance:
mandatory- This method must be implemented.
-
getAssessmentIdsByBanks
IdList getAssessmentIdsByBanks(IdList bankIds) throws OperationFailedException, PermissionDeniedException Gets the list ofAssessment Idscorresponding to a list ofBanks.- Parameters:
bankIds- list of bankIds- Returns:
- list of bank
Ids - Throws:
NullArgumentException-bankIdsisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure occurred- Compliance:
mandatory- This method must be implemented.
-
getAssessmentsByBanks
AssessmentList getAssessmentsByBanks(IdList bankIds) throws OperationFailedException, PermissionDeniedException Gets the list ofAssessmentscorresponding to a list ofBanks.- Parameters:
bankIds- list of bankIds- Returns:
- list of assessments
- Throws:
NullArgumentException-bankIdsisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure occurred- Compliance:
mandatory- This method must be implemented.
-
getBankIdsByAssessment
IdList getBankIdsByAssessment(Id assessmentId) throws NotFoundException, OperationFailedException, PermissionDeniedException Gets the list ofBankIdsmapped to anAssessment.- Parameters:
assessmentId-Idof anAssessment- Returns:
- list of bank
Ids - Throws:
NotFoundException-assessmentIdis not foundNullArgumentException-assessmentIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure occurred- Compliance:
mandatory- This method must be implemented.
-
getBanksByAssessment
BankList getBanksByAssessment(Id assessmentId) throws NotFoundException, OperationFailedException, PermissionDeniedException Gets the list ofBanksmapped to anAssessment.- Parameters:
assessmentId-Idof anAssessment- Returns:
- list of banks
- Throws:
NotFoundException-assessmentIdis not foundNullArgumentException-assessmentIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure occurred- Compliance:
mandatory- This method must be implemented.
-