public interface AssessmentBankAssignmentSession extends OsidSession
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
).
Modifier and Type | Method and Description |
---|---|
void |
assignAssessmentToBank(Id assessmentId,
Id bankId)
Adds an existing
Assessment to a Bank. |
boolean |
canAssignAssessments()
Tests if this user can alter assessment/bank mappings.
|
boolean |
canAssignAssessmentsToBank(Id bankId)
Tests if this user can alter assessment/bank mappings.
|
IdList |
getAssignableBankIds(Id bankId)
Gets a list of banks including and under the given banks node in which
any assessment can be assigned.
|
IdList |
getAssignableBankIdsForAssessment(Id bankId,
Id assessmentId)
Gets a list of bank including and under the given bank node in which a
specific assessment can be assigned.
|
void |
reassignAssessmentToBilling(Id assessmentId,
Id fromBankId,
Id toBankId)
Moves an
Assessment from one Bank to
another. |
void |
unassignAssessmentFromBank(Id assessmentId,
Id bankId)
Removes an
Assessment from a Bank. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignAssessments()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignAssessmentsToBank(Id bankId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup operations to
unauthorized users.bankId
- the Id
of the Bank
false
if mapping is not authorized, true
otherwiseNullArgumentException
- bankId
is
null
mandatory
- This method must be implemented. IdList getAssignableBankIds(Id bankId) throws OperationFailedException
bankId
- the Id
of the Bank
Ids
NullArgumentException
- bankId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableBankIdsForAssessment(Id bankId, Id assessmentId) throws OperationFailedException
bankId
- the Id
of the Bank
assessmentId
- the Id
of the Assessment
Ids
NullArgumentException
- bankId
or
assessmentId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignAssessmentToBank(Id assessmentId, Id bankId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Assessment
to a Bank.
assessmentId
- the Id
of the Assessment
bankId
- the Id
of the Bank
AlreadyExistsException
- assessmentId
is
already assigned to bankId
NotFoundException
- assessmentId
or
bankId
not foundNullArgumentException
- assessmentId
or
bankId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void unassignAssessmentFromBank(Id assessmentId, Id bankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Assessment
from a Bank.
assessmentId
- the Id
of the Assessment
bankId
- the Id
of the Bank
NotFoundException
- assessmentId
or
bankId
not found or assessmentId
not assigned to bankId
NullArgumentException
- assessmentId
or
bankId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void reassignAssessmentToBilling(Id assessmentId, Id fromBankId, Id toBankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Assessment
from one Bank
to
another. Mappings to other Banks
are unaffected.assessmentId
- the Id
of the Assessment
fromBankId
- the Id
of the current Bank
toBankId
- the Id
of the destination Bank
NotFoundException
- assessmentId, fromBankId,
or toBankId
not found or
assessmentId
not mapped to fromBankId
NullArgumentException
- assessmentId,
fromBankId,
or toBankId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.