public interface CourseRequirementForm extends OsidRuleForm, OsidAggregateableForm
This is the form for creating and updating CourseRequirements.
Like all OsidForm
objects, various data elements
may be set here for use in the create and update methods in the
RequisiteAdminSession.
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 |
clearMinimumEarnedCredits()
Clears the minimum earned credits.
|
void |
clearMinimumGrade()
Clears the minimum grade.
|
void |
clearMinimumScore()
Clears the minimum score.
|
void |
clearMinimumScoreSystem()
Clears the minimum score system.
|
void |
clearRequiresCompletion()
Clears the requires completion flag.
|
void |
clearTimeframe()
Clears the timeframe.
|
CourseRequirementFormRecord |
getCourseRequirementFormRecord(Type courseRequirementRecordType)
Gets the
CourseRequirementFormRecord corresponding to
the given course requirement record Type. |
Metadata |
getMinimumEarnedCreditsMetadata()
Gets the metadata for the minimum earned credits
|
Metadata |
getMinimumGradeMetadata()
Gets the metadata for the minimum grade.
|
Metadata |
getMinimumScoreMetadata()
Gets the metadata for the minimum score.
|
Metadata |
getMinimumScoreSystemMetadata()
Gets the metadata for the minimum score system.
|
Metadata |
getRequiresCompletionMetadata()
Gets the metadata for the requires completion flag.
|
Metadata |
getTimeframeMetadata()
Gets the metadata for the timeframe.
|
void |
setMinimumEarnedCredits(java.math.BigDecimal credits)
Sets the minimum earned credits.
|
void |
setMinimumGrade(Id gradeId)
Sets the minimum grade.
|
void |
setMinimumScore(java.math.BigDecimal score)
Sets the minimum score.
|
void |
setMinimumScoreSystem(Id gradeSystemId)
Sets the minimum score system.
|
void |
setRequiresCompletion(boolean completion)
Sets the requires completion flag.
|
void |
setTimeframe(Duration duration)
Sets the timeframe.
|
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 getRequiresCompletionMetadata()
mandatory
- This method must be implemented. void setRequiresCompletion(boolean completion)
completion
- the new requires completion flagInvalidArgumentException
- completion
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearRequiresCompletion()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getTimeframeMetadata()
mandatory
- This method must be implemented. void setTimeframe(Duration duration)
duration
- the new durationInvalidArgumentException
- duration
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- duration
is
null
mandatory
- This method must be implemented. void clearTimeframe()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getMinimumGradeMetadata()
mandatory
- This method must be implemented. void setMinimumGrade(Id gradeId)
gradeId
- the new gradeInvalidArgumentException
- gradeId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- gradeId
is
null
mandatory
- This method must be implemented. void clearMinimumGrade()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getMinimumScoreSystemMetadata()
mandatory
- This method must be implemented. void setMinimumScoreSystem(Id gradeSystemId)
gradeSystemId
- the new grade systemInvalidArgumentException
- gradeSystemId
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- gradeSystemId
is
null
mandatory
- This method must be implemented. void clearMinimumScoreSystem()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getMinimumScoreMetadata()
mandatory
- This method must be implemented. void setMinimumScore(java.math.BigDecimal score)
score
- the new minimum scoreInvalidArgumentException
- score
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearMinimumScore()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getMinimumEarnedCreditsMetadata()
mandatory
- This method must be implemented. void setMinimumEarnedCredits(java.math.BigDecimal credits)
credits
- the new minimum earned creditsInvalidArgumentException
- credits
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearMinimumEarnedCredits()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. CourseRequirementFormRecord getCourseRequirementFormRecord(Type courseRequirementRecordType) throws OperationFailedException
CourseRequirementFormRecord
corresponding to
the given course requirement record Type.
courseRequirementRecordType
- a course requirement record typeNullArgumentException
-
courseRequirementRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(courseRequirementRecordType)
is
false
mandatory
- This method must be implemented.