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

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

MethodcanAssignSequenceRuleEnablers
Description

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.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignSequenceRuleEnablersToBank
Description

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.

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 bank including and under the given bank node in which any sequence rule enabler 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.
MethodgetAssignableBankIdsForSequenceRuleEnabler
Description

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

Parametersosid.id.IdbankIdthe Id of the Bank
osid.id.IdsequenceRuleEnablerIdthe Id of the SequenceRuleEnabler
Returnosid.id.IdListlist of assignable bank Ids
ErrorsNULL_ARGUMENT bankId or sequenceRuleEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignSequenceRuleEnablerToBank
Description

Adds an existing SequenceRuleEnabler to a Bank.

Parametersosid.id.IdsequenceRuleEnablerIdthe Id of the SequenceRuleEnabler
osid.id.IdbankIdthe Id of the Bank
ErrorsALREADY_EXISTS sequenceRuleEnablerId is already assigned to bankId
NOT_FOUND sequenceRuleEnablerId or bankId not found
NULL_ARGUMENT sequenceRuleEnablerId or bankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignSequenceRuleEnablerFromBank
Description

Removes a SequenceRuleEnabler from a Bank.

Parametersosid.id.IdsequenceRuleEnablerIdthe Id of the SequenceRuleEnabler
osid.id.IdbankIdthe Id of the Bank
ErrorsNOT_FOUND sequenceRuleEnablerId or bankId not found or sequenceRuleEnablerId not assigned to bankId
NULL_ARGUMENT sequenceRuleEnablerId or bankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.