public interface CourseEntryForm extends OsidRelationshipForm
This is the form for creating and updating courseEntries.
Like all OsidForm
objects, various data elements
may be set here for use in the create and update methods in the
CourseEntryAdminSession.
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 |
clearComplete()
Clears the complete flag.
|
void |
clearCreditScale()
Clears the credit scale.
|
void |
clearCreditsEarned()
Clears the credits earned.
|
void |
clearGrade()
Clears the grade.
|
void |
clearScore()
Clears the score.
|
void |
clearScoreScale()
Clears the score scale.
|
void |
clearTerm()
Clears the term.
|
Metadata |
getCompleteMetadata()
Gets the metadata for the completion flag.
|
CourseEntryFormRecord |
getCourseEntryFormRecord(Type courseEntryRecordType)
Gets the
CourseEntryFormRecord corresponding to the
given course entry record Type. |
Metadata |
getCreditScaleMetadata()
Gets the metadata for the credit scale.
|
Metadata |
getCreditsEarnedMetadata()
Gets the metadata for the credits earned.
|
Metadata |
getGradeMetadata()
Gets the metadata for the grade.
|
Metadata |
getScoreMetadata()
Gets the metadata for the score.
|
Metadata |
getScoreScaleMetadata()
Gets the metadata for the score scale.
|
Metadata |
getTermMetadata()
Gets the metadata for the term.
|
void |
setComplete(boolean complete)
Sets the program is complete flag.
|
void |
setCreditScale(Id gradeSystemId)
Sets the credit scale.
|
void |
setCreditsEarned(java.math.BigDecimal credits)
Sets the credits earned.
|
void |
setGrade(Id gradeId)
Sets the grade.
|
void |
setScore(java.math.BigDecimal score)
Sets the score.
|
void |
setScoreScale(Id gradeSystemId)
Sets the score scale.
|
void |
setTerm(Id termId)
Sets the term.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate
Metadata getTermMetadata()
mandatory
- This method must be implemented. void setTerm(Id termId)
termId
- the new termInvalidArgumentException
- termId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- termId
is
null
mandatory
- This method must be implemented. void clearTerm()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getCompleteMetadata()
mandatory
- This method must be implemented. void setComplete(boolean complete)
complete
- the new complete flagInvalidArgumentException
- complete
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearComplete()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getCreditScaleMetadata()
mandatory
- This method must be implemented. void setCreditScale(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 clearCreditScale()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getCreditsEarnedMetadata()
mandatory
- This method must be implemented. void setCreditsEarned(java.math.BigDecimal credits)
credits
- the new creditsInvalidArgumentException
- credits
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearCreditsEarned()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getGradeMetadata()
mandatory
- This method must be implemented. void setGrade(Id gradeId)
gradeId
- the new gradeInvalidArgumentException
- gradeId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- gradeId
is
null
mandatory
- This method must be implemented. void clearGrade()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getScoreScaleMetadata()
mandatory
- This method must be implemented. void setScoreScale(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 clearScoreScale()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getScoreMetadata()
mandatory
- This method must be implemented. void setScore(java.math.BigDecimal score)
score
- the new scoreInvalidArgumentException
- score
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearScore()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. CourseEntryFormRecord getCourseEntryFormRecord(Type courseEntryRecordType) throws OperationFailedException
CourseEntryFormRecord
corresponding to the
given course entry record Type.
courseEntryRecordType
- a course entry record typeNullArgumentException
- courseEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(courseEntryRecordType)
is false
mandatory
- This method must be implemented.