public interface AssessmentOfferedBankAssignmentSession extends OsidSession
This session provides methods to re-assign AssessmentOffered
objects to Banks.
An AssessmentOffered
may map to multiple Banks
and removing the last
reference to an AssessmentOffered
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 AssessmentOffered
to
another Bank
is not a copy operation (eg: does not change
its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignAssessmentOfferedToBank(Id assessmentOfferedId,
Id bankId)
Adds an existing
AssessmentOffered to a Bank. |
boolean |
canAssignAssessmentsOffered()
Tests if this user can alter assessment offered/bank mappings.
|
boolean |
canAssignAssessmentsOfferedToBank(Id bankId)
Tests if this user can alter assessment offered/bank mappings.
|
IdList |
getAssignableBankIds(Id bankId)
Gets a list of banks including and under the given banks node in which
any assessment offered can be assigned.
|
IdList |
getAssignableBankIdsForAssessmentOffered(Id bankId,
Id assessmentOfferedId)
Gets a list of bank including and under the given bank node in which a
specific assessment offered can be assigned.
|
void |
reassignAssessmentOfferedToBilling(Id assessmentOfferedId,
Id fromBankId,
Id toBankId)
Moves an
AssessmentOffered from one Bank
to another. |
void |
unassignAssessmentOfferedFromBank(Id assessmentOfferedId,
Id bankId)
Removes an
AssessmentOffered from a Bank. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignAssessmentsOffered()
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 canAssignAssessmentsOfferedToBank(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 getAssignableBankIdsForAssessmentOffered(Id bankId, Id assessmentOfferedId) throws OperationFailedException
bankId
- the Id
of the Bank
assessmentOfferedId
- the Id
of the
AssessmentOffered
Ids
NullArgumentException
- bankId
or
assessmentOfferedId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignAssessmentOfferedToBank(Id assessmentOfferedId, Id bankId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
AssessmentOffered
to a Bank.
assessmentOfferedId
- the Id
of the
AssessmentOffered
bankId
- the Id
of the Bank
AlreadyExistsException
- assessmentOfferedId
is already assigned to bankId
NotFoundException
- assessmentOfferedId
or bankId
not foundNullArgumentException
- assessmentOfferedId
or bankId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void unassignAssessmentOfferedFromBank(Id assessmentOfferedId, Id bankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AssessmentOffered
from a Bank.
assessmentOfferedId
- the Id
of the
AssessmentOffered
bankId
- the Id
of the Bank
NotFoundException
- assessmentOfferedId
or bankId
not found or
assessmentOfferedId
not assigned to bankId
NullArgumentException
- assessmentOfferedId
or bankId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void reassignAssessmentOfferedToBilling(Id assessmentOfferedId, Id fromBankId, Id toBankId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AssessmentOffered
from one Bank
to another. Mappings to other Banks
are unaffected.assessmentOfferedId
- the Id
of the
AssessmentOffered
fromBankId
- the Id
of the current Bank
toBankId
- the Id
of the destination Bank
NotFoundException
- assessmentOfferedId,
fromBankId,
or toBankId
not found or
assessmentOfferedId
not mapped to
fromBankId
NullArgumentException
- assessmentOfferedId,
fromBankId,
or toBankId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.