org.osid.assessment.authoring

Interface SequenceRuleForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, Suppliable

public interface SequenceRuleForm
extends OsidRuleForm

This is the form for creating and updating sequence rules. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the SequenceSession For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyAssessmentParts(Id[] assessmentPartIds) Designates assessment parts to which the rule applies.
Metadata	getAppliedAssessmentPartsMetadata() Gets the metadata for the applied assessment parts.
Metadata	getCumulativeMetadata() Gets the metadata for the cumulative flag.
Metadata	getMaximumScoreMetadata() Gets the metadata for the maximum score.
Metadata	getMinimumScoreMetadata() Gets the metadata for the minimum score.
SequenceRuleFormRecord	getSequenceRuleFormRecord(Type sequenceRuleRecord) Gets the SequenceRuleFormRecord corresponding to the given sequence rule record Type.
void	setCumulative(boolean cumulative) Applies this rule to all previous assessment parts.
void	setMaximumScore(long score) Sets the maximum score for this rule.
void	setMinimumScore(long score) Sets the minimum score for this rule.

Methods inherited from interface org.osid.OsidRuleForm

clearRule, getRuleMetadata, setRule

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Method Detail

getMinimumScoreMetadata

Metadata getMinimumScoreMetadata()

Gets the metadata for the minimum score.

Returns:

metadata for the minimum score

Compliance:

mandatory - This method must be implemented.

setMinimumScore

void setMinimumScore(long score)

Sets the minimum score for this rule.

Parameters:

score - minimum score

Throws:

InvalidArgumentException - score is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getMaximumScoreMetadata

Metadata getMaximumScoreMetadata()

Gets the metadata for the maximum score.

Returns:

metadata for the maximum score

Compliance:

mandatory - This method must be implemented.

setMaximumScore

void setMaximumScore(long score)

Sets the maximum score for this rule.

Parameters:

score - maximum score

Throws:

InvalidArgumentException - score is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getCumulativeMetadata

Metadata getCumulativeMetadata()

Gets the metadata for the cumulative flag.

Returns:

metadata for the cumulative flag

Compliance:

mandatory - This method must be implemented.

setCumulative

void setCumulative(boolean cumulative)

Applies this rule to all previous assessment parts.

Parameters:

cumulative - true to apply to all previous assessment parts. false to apply to the immediate previous assessment part

Throws:

InvalidArgumentException - cumulative is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getAppliedAssessmentPartsMetadata

Metadata getAppliedAssessmentPartsMetadata()

Gets the metadata for the applied assessment parts.

Returns:

metadata for the applied assessment parts

Compliance:

mandatory - This method must be implemented.

applyAssessmentParts

void applyAssessmentParts(Id[] assessmentPartIds)

Designates assessment parts to which the rule applies.

Parameters:

assessmentPartIds - the parts to which this rule should apply

Throws:

InvalidArgumentException - assessmentPartIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - assessmentPartIds is null

Compliance:

mandatory - This method must be implemented.

getSequenceRuleFormRecord

SequenceRuleFormRecord getSequenceRuleFormRecord(Type sequenceRuleRecord)
                                                 throws OperationFailedException

Gets the SequenceRuleFormRecord corresponding to the given sequence rule record Type.

Parameters:

sequenceRuleRecord - a sequence rule record type

Returns:

the sequence rule record

Throws:

NullArgumentException - sequenceRuleRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(asequenceRuleRecordType) is false

Compliance:

mandatory - This method must be implemented.