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

This session provides methods to apply SequenceRuleEnablers to SequenceRules. a SequenceRule with multiple SequenceRuleEnablers means any positive rule evaluation across the enablers result in an effective SequenceRule.

MethodgetBankId
Description

Gets the Bank Id associated with this session.

Returnosid.id.Idthe Bank Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBank
Description

Gets the Bank associated with this session.

Returnosid.assessment.Bankthe bank
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAssignSequenceRuleEnablers
Description

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

Adds an existing SequenceRuleEnabler to a SequenceRule.

Parametersosid.id.IdsequenceRuleEnablerIdthe Id of the SequenceRuleEnabler
osid.id.IdsequenceRuleIdthe Id of the SequenceRule
ErrorsALREADY_EXISTS sequenceRuleEnablerId is already applied to sequenceRuleId
NOT_FOUND sequenceRuleEnablerId or sequenceRuleId not found
NULL_ARGUMENT sequenceRuleEnablerId or sequenceRuleId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignSequenceRuleEnablerFromSequenceRule
Description

Removes a SequenceRuleEnabler from a SequenceRule.

Parametersosid.id.IdsequenceRuleEnablerIdthe Id of the SequenceRuleEnabler
osid.id.IdsequenceRuleIdthe Id of the SequenceRule
ErrorsNOT_FOUND sequenceRuleEnablerId or sequenceRuleId not found or sequenceRuleEnablerId not applied to sequenceRuleId
NULL_ARGUMENT sequenceRuleEnablerId or sequenceRuleId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceSequenceRuleEnablers
Description

Tests if this user can order SequenceRuleEnablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returnboolean false if SequenceRuleEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveSequenceRuleEnablerAhead
Description

Reorders sequence rule enablers for a sequence rule by moving the specified sequence rule enabler in front of a reference sequence rule enabler.

Parametersosid.id.IdsequenceRuleEnablerIdthe Id of a SequenceRuleEnabler
osid.id.IdsequenceRuleIdthe Id of a SequenceRule
osid.id.IdreferenceIdthe reference sequence rule enabler Id
ErrorsNOT_FOUND sequenceRuleEnablerId, sequenceRuleId, or referenceId not found or, sequenceRuleEnablerId or referenceId not related to sequenceRuleId
NULL_ARGUMENT sequenceRuleEnablerId, sequenceRuleId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveSequenceRuleEnablerBehind
Description

Reorders sequence rule enablers for a sequence rule by moving the specified sequence rule enabler behind a reference sequence rule enabler.

Parametersosid.id.IdsequenceRuleEnablerIdthe Id of a SequenceRuleEnabler
osid.id.IdsequenceRuleIdthe Id of a SequenceRule
osid.id.IdreferenceIdthe reference sequence rule enabler Id
ErrorsNOT_FOUND sequenceRuleEnablerId, sequenceRuleId, or referenceId not found or, sequenceRuleEnablerId or referenceId not related to sequenceRuleId
NULL_ARGUMENT sequenceRuleEnablerId, sequenceRuleId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderSequenceRuleEnablers
Description

Reorders a set of sequence rule enablers for a sequence rule.

Parametersosid.id.Id[]sequenceRuleEnablerIdsthe Ids for a set of SequenceRuleEnablers
osid.id.IdsequenceRuleIdthe Id of a SequenceRule
ErrorsNOT_FOUND sequenceRuleId not found or, an sequenceRuleEnablerId not related to sequenceRuleId
NULL_ARGUMENT sequenceRuleEnablerIds or sequenceRuleId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.