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

This session provides methods to re-assign Assessments to Banks. An Assessment may map to multiple Banks and removing the last reference to an Assessment is the equivalent of deleting it. Each Bank may have its own authorizations governing who is allowed to operate on it.

Moving or adding a reference of an Assessment to another Bank is not a copy operation (eg: does not change its Id ).

MethodcanAssignAssessments
Description

Tests if this user can alter assessment/bank mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignAssessmentsToBank
Description

Tests if this user can alter assessment/bank mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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.

Parametersosid.id.IdbankIdthe Id of the Bank
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT bankId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableBankIds
Description

Gets a list of banks including and under the given banks node in which any assessment can be assigned.

Parametersosid.id.IdbankIdthe Id of the Bank
Returnosid.id.IdListlist of assignable bank Ids
ErrorsNULL_ARGUMENT bankId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableBankIdsForAssessment
Description

Gets a list of bank including and under the given bank node in which a specific assessment can be assigned.

Parametersosid.id.IdbankIdthe Id of the Bank
osid.id.IdassessmentIdthe Id of the Assessment
Returnosid.id.IdListlist of assignable bank Ids
ErrorsNULL_ARGUMENT bankId or assessmentId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignAssessmentToBank
Description

Adds an existing Assessment to a Bank.

Parametersosid.id.IdassessmentIdthe Id of the Assessment
osid.id.IdbankIdthe Id of the Bank
ErrorsALREADY_EXISTS assessmentId is already assigned to bankId
NOT_FOUND assessmentId or bankId not found
NULL_ARGUMENT assessmentId or bankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodunassignAssessmentFromBank
Description

Removes an Assessment from a Bank.

Parametersosid.id.IdassessmentIdthe Id of the Assessment
osid.id.IdbankIdthe Id of the Bank
ErrorsNOT_FOUND assessmentId or bankId not found or assessmentId not assigned to bankId
NULL_ARGUMENT assessmentId or bankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodreassignAssessmentToBilling
Description

Moves an Assessment from one Bank to another. Mappings to other Banks are unaffected.

Parametersosid.id.IdassessmentIdthe Id of the Assessment
osid.id.IdfromBankIdthe Id of the current Bank
osid.id.IdtoBankIdthe Id of the destination Bank
ErrorsNOT_FOUND assessmentId, fromBankId, or toBankId not found or assessmentId not mapped to fromBankId
NULL_ARGUMENT assessmentId, fromBankId, or toBankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.