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.
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.
|
clearRule, getRuleMetadata, setRule
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled
Metadata getMinimumScoreMetadata()
mandatory
- This method must be implemented. void setMinimumScore(long score)
score
- minimum scoreInvalidArgumentException
- score
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getMaximumScoreMetadata()
mandatory
- This method must be implemented. void setMaximumScore(long score)
score
- maximum scoreInvalidArgumentException
- score
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getCumulativeMetadata()
mandatory
- This method must be implemented. void setCumulative(boolean cumulative)
cumulative
- true
to apply to all previous
assessment parts. false
to apply to the
immediate previous assessment partInvalidArgumentException
- cumulative
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getAppliedAssessmentPartsMetadata()
mandatory
- This method must be implemented. void applyAssessmentParts(Id[] assessmentPartIds)
assessmentPartIds
- the parts to which this rule should applyInvalidArgumentException
- assessmentPartIds
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- assessmentPartIds
is null
mandatory
- This method must be implemented. SequenceRuleFormRecord getSequenceRuleFormRecord(Type sequenceRuleRecord) throws OperationFailedException
SequenceRuleFormRecord
corresponding to the
given sequence rule record Type.
sequenceRuleRecord
- a sequence rule record typeNullArgumentException
- sequenceRuleRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(asequenceRuleRecordType)
is false
mandatory
- This method must be implemented.