public interface CourseForm extends OsidObjectForm, OsidOperableForm
This is the form for creating and updating Courses.
Like
all OsidForm
objects, various data elements may be set here
for use in the create and update methods in the CourseAdminSession.
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 |
clearCredits()
Removes the credits.
|
void |
clearGradingOptions()
Removes the grading options.
|
void |
clearLearningObjectives()
Removes the learning objectives.
|
void |
clearLevels()
Removes the grade levels.
|
void |
clearNumber()
Removes the course number.
|
void |
clearPrerequisites()
Removes the prerequisites.
|
void |
clearPrerequisitesInfo()
Removes the prerequisite information.
|
void |
clearSponsors()
Removes the sponsors.
|
void |
clearTitle()
Removes the title.
|
CourseFormRecord |
getCourseFormRecord(Type courseRecordType)
Gets the
CourseFormRecord corresponding to the given
course record Type. |
Metadata |
getCreditsMetadata()
Gets the metadata for the credits.
|
Metadata |
getGradingOptionsMetadata()
Gets the metadata for a set of grading options.
|
Metadata |
getLearningObjectiveMetadata()
Gets the metadata for a set of learning objectives.
|
Metadata |
getLevelsMetadata()
Gets the metadata for a set of grade levels.
|
Metadata |
getNumberMetadata()
Gets the metadata for a course number.
|
Metadata |
getPrerequisitesInfoMetadata()
Gets the metadata for a course prerequisite informational string.
|
Metadata |
getPrerequisitesMetadata()
Gets the metadata for a prerequisites.
|
Metadata |
getSponsorsMetadata()
Gets the metadata for a set of sponsors.
|
Metadata |
getTitleMetadata()
Gets the metadata for a course title.
|
void |
setCredits(Id[] gradeIds)
Sets the credits.
|
void |
setGradingOptions(Id[] gradeSystemIds)
Sets the grading options.
|
void |
setLearningObjectives(Id[] objectiveIds)
Sets the learning objectives.
|
void |
setLevels(Id[] gradeIds)
Sets the levels.
|
void |
setNumber(java.lang.String number)
Sets the course number.
|
void |
setPrerequisites(Id[] requisiteIds)
Sets the prerequisites.
|
void |
setPrerequisitesInfo(java.lang.String prereqInfo)
Sets the prerequisitie information.
|
void |
setSponsors(Id[] resourceIds)
Sets the sponsors.
|
void |
setTitle(java.lang.String title)
Sets the title.
|
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 getTitleMetadata()
mandatory
- This method must be implemented. void setTitle(java.lang.String title)
title
- the new titleInvalidArgumentException
- title
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- title
is
null
mandatory
- This method must be implemented. void clearTitle()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getNumberMetadata()
mandatory
- This method must be implemented. void setNumber(java.lang.String number)
number
- the new course numberInvalidArgumentException
- number
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- number
is
null
mandatory
- This method must be implemented. void clearNumber()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getSponsorsMetadata()
mandatory
- This method must be implemented. void setSponsors(Id[] resourceIds)
resourceIds
- the new sponsorsInvalidArgumentException
- resourceIds
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- resourceIds
is
null
mandatory
- This method must be implemented. void clearSponsors()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getCreditsMetadata()
mandatory
- This method must be implemented. void setCredits(Id[] gradeIds)
gradeIds
- the new credit levelsInvalidArgumentException
- gradeIds
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- gradeIds
is
null
mandatory
- This method must be implemented. void clearCredits()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getPrerequisitesInfoMetadata()
mandatory
- This method must be implemented. void setPrerequisitesInfo(java.lang.String prereqInfo)
prereqInfo
- the new prerequsite informationInvalidArgumentException
- prereqInfo
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- prereqInfo
is
null
mandatory
- This method must be implemented. void clearPrerequisitesInfo()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getPrerequisitesMetadata()
mandatory
- This method must be implemented. void setPrerequisites(Id[] requisiteIds)
requisiteIds
- the new requisitesInvalidArgumentException
- requisiteIds
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- requisiteIds
is
null
mandatory
- This method must be implemented. void clearPrerequisites()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getLevelsMetadata()
mandatory
- This method must be implemented. void setLevels(Id[] gradeIds)
gradeIds
- the new grade levelsInvalidArgumentException
- gradeIds
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- gradeIds
is
null
mandatory
- This method must be implemented. void clearLevels()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getGradingOptionsMetadata()
mandatory
- This method must be implemented. void setGradingOptions(Id[] gradeSystemIds)
gradeSystemIds
- the new grade systemsInvalidArgumentException
- gradeSystemIds
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- gradeSystemIds
is null
mandatory
- This method must be implemented. void clearGradingOptions()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getLearningObjectiveMetadata()
mandatory
- This method must be implemented. void setLearningObjectives(Id[] objectiveIds)
objectiveIds
- the new obejctivesInvalidArgumentException
- objectiveIds
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- objectiveIds
is
null
mandatory
- This method must be implemented. void clearLearningObjectives()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. CourseFormRecord getCourseFormRecord(Type courseRecordType) throws OperationFailedException
CourseFormRecord
corresponding to the given
course record Type.
courseRecordType
- a course record typeNullArgumentException
- courseRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(courseRecordType)
is false
mandatory
- This method must be implemented.