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

This session provides methods to re-assign SequenceRule to Bank mappings. a SequenceRule may appear in multiple Bank objects and removing the last reference to a SequenceRule 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 SequenceRule to another Bank is not a copy operation (eg: does not change its Id ).

MethodcanAssignSequenceRules
Description

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

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

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

Parametersosid.id.IdbankIdthe Id of the Bank
osid.id.IdsequenceRuleIdthe Id of the SequenceRule
Returnosid.id.IdListlist of assignable bank Ids
ErrorsNULL_ARGUMENT bankId or sequenceRuleId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignSequenceRuleToBank
Description

Adds an existing SequenceRule to a Bank.

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

Removes a SequenceRule from a Bank.

Parametersosid.id.IdsequenceRuleIdthe Id of the SequenceRule
osid.id.IdbankIdthe Id of the Bank
ErrorsNOT_FOUND sequenceRuleId or bankId not found or sequenceRuleId not assigned to bankId
NULL_ARGUMENT sequenceRuleId or bankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignSequenceRuleToBank
Description

Moves a SequenceRule from one Bank to another. Mappings to other Banks are unaffected.

Parametersosid.id.IdsequenceRuleIdthe Id of the SequenceRule
osid.id.IdfromBankIdthe Id of the current Bank
osid.id.IdtoBankIdthe Id of the destination Bank
ErrorsNOT_FOUND sequenceRuleId, fromBankId, or toBankId not found or sequenceRuleId not mapped to fromBankId
NULL_ARGUMENT sequenceRuleId, fromBankId, or toBankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.