org.osid.assessment.authoring

Interface SequenceRuleEnablerBankAssignmentSession

All Superinterfaces:

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

public interface SequenceRuleEnablerBankAssignmentSession
extends OsidSession

This session provides methods to re-assign SequenceRuleEnabler to Bank mappings. a SequenceRuleEnabler may appear in multiple Bank objects and removing the last reference to a SequenceRuleEnabler is the equivalent of deleting it. Each Bank may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a SequenceRuleEnabler to another Bank is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignSequenceRuleEnablerToBank(Id sequenceRuleEnablerId, Id bankId) Adds an existing SequenceRuleEnabler to a Bank.
boolean	canAssignSequenceRuleEnablers() Tests if this user can alter sequence rule enabler/bank mappings.
boolean	canAssignSequenceRuleEnablersToBank(Id bankId) Tests if this user can alter sequence rule enabler/bank mappings.
IdList	getAssignableBankIds(Id bankId) Gets a list of bank including and under the given bank node in which any sequence rule enabler can be assigned.
IdList	getAssignableBankIdsForSequenceRuleEnabler(Id bankId, Id sequenceRuleEnablerId) Gets a list of bank including and under the given bank node in which a specific sequence rule enabler can be assigned.
void	unassignSequenceRuleEnablerFromBank(Id sequenceRuleEnablerId, Id bankId) Removes a SequenceRuleEnabler 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

canAssignSequenceRuleEnablers

boolean canAssignSequenceRuleEnablers()

Tests if this user can alter sequence rule enabler/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.

canAssignSequenceRuleEnablersToBank

boolean canAssignSequenceRuleEnablersToBank(Id bankId)

Tests if this user can alter sequence rule enabler/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 bank including and under the given bank node in which any sequence rule enabler 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.

getAssignableBankIdsForSequenceRuleEnabler

IdList getAssignableBankIdsForSequenceRuleEnabler(Id bankId,
                                                Id sequenceRuleEnablerId)
                                                  throws OperationFailedException

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

Parameters:

bankId - the Id of the Bank

sequenceRuleEnablerId - the Id of the SequenceRuleEnabler

Returns:

list of assignable bank Ids

Throws:

NullArgumentException - bankId or sequenceRuleEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignSequenceRuleEnablerToBank

void assignSequenceRuleEnablerToBank(Id sequenceRuleEnablerId,
                                   Id bankId)
                                     throws AlreadyExistsException,
                                            NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

Adds an existing SequenceRuleEnabler to a Bank.

Parameters:

sequenceRuleEnablerId - the Id of the SequenceRuleEnabler

bankId - the Id of the Bank

Throws:

AlreadyExistsException - sequenceRuleEnablerId is already assigned to bankId

NotFoundException - sequenceRuleEnablerId or bankId not found

NullArgumentException - sequenceRuleEnablerId or bankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignSequenceRuleEnablerFromBank

void unassignSequenceRuleEnablerFromBank(Id sequenceRuleEnablerId,
                                       Id bankId)
                                         throws NotFoundException,
                                                OperationFailedException,
                                                PermissionDeniedException

Removes a SequenceRuleEnabler from a Bank.

Parameters:

sequenceRuleEnablerId - the Id of the SequenceRuleEnabler

bankId - the Id of the Bank

Throws:

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

NullArgumentException - sequenceRuleEnablerId or bankId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.