org.osid.assessment

Interface AssessmentOfferedBankAssignmentSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

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 ).

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canAssignAssessmentsOffered

boolean canAssignAssessmentsOffered()

Tests if this user can alter assessment offered/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.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignAssessmentsOfferedToBank

boolean canAssignAssessmentsOfferedToBank(Id bankId)

Tests if this user can alter assessment offered/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.

Parameters:

bankId - the Id of the Bank

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - bankId is null

Compliance:

mandatory - This method must be implemented.

getAssignableBankIds

IdList getAssignableBankIds(Id bankId)
                            throws OperationFailedException

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

Parameters:

bankId - the Id of the Bank

Returns:

list of assignable bank Ids

Throws:

NullArgumentException - bankId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableBankIdsForAssessmentOffered

IdList getAssignableBankIdsForAssessmentOffered(Id bankId,
                                              Id assessmentOfferedId)
                                                throws OperationFailedException

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

Parameters:

bankId - the Id of the Bank

assessmentOfferedId - the Id of the AssessmentOffered

Returns:

list of assignable bank Ids

Throws:

NullArgumentException - bankId or assessmentOfferedId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignAssessmentOfferedToBank

void assignAssessmentOfferedToBank(Id assessmentOfferedId,
                                 Id bankId)
                                   throws AlreadyExistsException,
                                          NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Adds an existing AssessmentOffered to a Bank.

Parameters:

assessmentOfferedId - the Id of the AssessmentOffered

bankId - the Id of the Bank

Throws:

AlreadyExistsException - assessmentOfferedId is already assigned to bankId

NotFoundException - assessmentOfferedId or bankId not found

NullArgumentException - assessmentOfferedId or bankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

unassignAssessmentOfferedFromBank

void unassignAssessmentOfferedFromBank(Id assessmentOfferedId,
                                     Id bankId)
                                       throws NotFoundException,
                                              OperationFailedException,
                                              PermissionDeniedException

Removes an AssessmentOffered from a Bank.

Parameters:

assessmentOfferedId - the Id of the AssessmentOffered

bankId - the Id of the Bank

Throws:

NotFoundException - assessmentOfferedId or bankId not found or assessmentOfferedId not assigned to bankId

NullArgumentException - assessmentOfferedId or bankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

reassignAssessmentOfferedToBilling

void reassignAssessmentOfferedToBilling(Id assessmentOfferedId,
                                      Id fromBankId,
                                      Id toBankId)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

assessmentOfferedId - the Id of the AssessmentOffered

fromBankId - the Id of the current Bank

toBankId - the Id of the destination Bank

Throws:

NotFoundException - assessmentOfferedId, fromBankId, or toBankId not found or assessmentOfferedId not mapped to fromBankId

NullArgumentException - assessmentOfferedId, fromBankId, or toBankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.