OSID Logo
OSID Specifications
assessment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.AssessmentBankSession
Implementsosid.OsidSession
Description

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
MethodcanLookupAssessmentBankMappings
Description

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 a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeBankView
Description

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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryBankView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetAssessmentIdsByBank
Description

Gets the list of Assessment Ids associated with a Bank.

Parametersosid.id.IdbankId Id of the Bank
Returnosid.id.IdListlist of related assessment Ids
ErrorsNOT_FOUND bankId is not found
NULL_ARGUMENT bankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsByBank
Description

Gets the list of Assessments associated with a Bank.

Parametersosid.id.IdbankId Id of the Bank
Returnosid.assessment.AssessmentListlist of related assessments
ErrorsNOT_FOUND bankId is not found
NULL_ARGUMENT bankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentIdsByBanks
Description

Gets the list of Assessment Ids corresponding to a list of Banks.

Parametersosid.id.IdListbankIdslist of bank Ids
Returnosid.id.IdListlist of bank Ids
ErrorsNULL_ARGUMENT bankIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsByBanks
Description

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

Parametersosid.id.IdListbankIdslist of bank Ids
Returnosid.assessment.AssessmentListlist of assessments
ErrorsNULL_ARGUMENT bankIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetBankIdsByAssessment
Description

Gets the list of Bank Ids mapped to an Assessment.

Parametersosid.id.IdassessmentId Id of an Assessment
Returnosid.id.IdListlist of bank Ids
ErrorsNOT_FOUND assessmentId is not found
NULL_ARGUMENT assessmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetBanksByAssessment
Description

Gets the list of Banks mapped to an Assessment.

Parametersosid.id.IdassessmentId Id of an Assessment
Returnosid.assessment.BankListlist of banks
ErrorsNOT_FOUND assessmentId is not found
NULL_ARGUMENT assessmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.