Interface CourseEntryForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidRelationshipForm, OsidTemporalForm, Suppliable

All Known Subinterfaces:

CourseEntryBatchForm

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.

Method Summary

Modifier and Type	Method	Description
void	clearComplete()	Clears the complete flag.
void	clearCourseBeginDate()	Clears the course begin date.
void	clearCourseEndDate()	Clears the course end date.
void	clearCreditScale()	Clears the credit scale.
void	clearCreditsEarned()	Clears the credits earned.
void	clearGrade()	Clears the grade.
void	clearIsRegistrationKnown()	Clears the is registration known flag.
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.
Metadata	getCourseBeginDateMetadata()	Gets the metadata for the course begin date.
Metadata	getCourseEndDateMetadata()	Gets the metadata for the course end date.
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	getIsRegistrationKnownMetadata()	Gets the metadata for the is registration known flag.
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	setCourseBeginDate(DateTime courseBeginDate)	Sets the course begin date.
void	setCourseEndDate(DateTime courseEndDate)	Sets the course end date.
void	setCreditScale(Id gradeSystemId)	Sets the credit scale.
void	setCreditsEarned(BigDecimal credits)	Sets the credits earned.
void	setGrade(Id gradeId)	Sets the grade.
void	setIsRegistrationKnown(boolean isRegistrationKnown)	Sets the is registration known flag.
void	setScore(BigDecimal score)	Sets the score.
void	setScoreScale(Id gradeSystemId)	Sets the score scale.
void	setTerm(Id termId)	Sets the term.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm.

Methods inherited from interface OsidForm

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

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

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

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Methods inherited from interface OsidRelationshipForm

clearEndReason, getEndReasonMetadata, setEndReason

Modifier and Type	Method	Description
void	clearEndReason()	Removes the end reason.
Metadata	getEndReasonMetadata()	Gets the metadata for the end reason.
void	setEndReason(Id stateId)	Sets the end reason.

Methods inherited from interface OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Modifier and Type	Method	Description
void	clearEndDate()	Clears the end date.
void	clearStartDate()	Clears the start date.
Metadata	getEndDateMetadata()	Gets the metadata for an end date.
Metadata	getStartDateMetadata()	Gets the metadata for a start date.
void	setEndDate(DateTime date)	Sets the end date.
void	setStartDate(DateTime date)	Sets the start date.

Method Details

getTermMetadata

Metadata getTermMetadata()

Gets the metadata for the term.

Returns:

metadata for the term

Compliance:

mandatory - This method must be implemented.

setTerm

void setTerm(Id termId)

Sets the term.

Parameters:

termId - the new term

Throws:

InvalidArgumentException - termId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - termId is null

Compliance:

mandatory - This method must be implemented.

clearTerm

void clearTerm()

Clears the term.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getIsRegistrationKnownMetadata

Metadata getIsRegistrationKnownMetadata()

Gets the metadata for the is registration known flag.

Returns:

metadata for the is registration known flag

Compliance:

mandatory - This method must be implemented.

setIsRegistrationKnown

void setIsRegistrationKnown(boolean isRegistrationKnown)

Sets the is registration known flag.

Parameters:

isRegistrationKnown - the new is registration known flag

Throws:

InvalidArgumentException - isRegistrationKnown is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearIsRegistrationKnown

void clearIsRegistrationKnown()

Clears the is registration known flag.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getCourseBeginDateMetadata

Metadata getCourseBeginDateMetadata()

Gets the metadata for the course begin date.

Returns:

metadata for the course begin date

Compliance:

mandatory - This method must be implemented.

setCourseBeginDate

void setCourseBeginDate(DateTime courseBeginDate)

Sets the course begin date.

Parameters:

courseBeginDate - the new course begin date

Throws:

InvalidArgumentException - courseBeginDate is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - courseBeginDate is null

Compliance:

mandatory - This method must be implemented.

clearCourseBeginDate

void clearCourseBeginDate()

Clears the course begin date.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getCourseEndDateMetadata

Metadata getCourseEndDateMetadata()

Gets the metadata for the course end date.

Returns:

metadata for the course end date

Compliance:

mandatory - This method must be implemented.

setCourseEndDate

void setCourseEndDate(DateTime courseEndDate)

Sets the course end date.

Parameters:

courseEndDate - the new course end date

Throws:

InvalidArgumentException - courseEndDate is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - courseEndDate is null

Compliance:

mandatory - This method must be implemented.

clearCourseEndDate

void clearCourseEndDate()

Clears the course end date.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getCompleteMetadata

Metadata getCompleteMetadata()

Gets the metadata for the completion flag.

Returns:

metadata for the complete flag

Compliance:

mandatory - This method must be implemented.

setComplete

void setComplete(boolean complete)

Sets the program is complete flag.

Parameters:

complete - the new complete flag

Throws:

InvalidArgumentException - complete is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearComplete

void clearComplete()

Clears the complete flag.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getCreditScaleMetadata

Metadata getCreditScaleMetadata()

Gets the metadata for the credit scale.

Returns:

metadata for the credit scale

Compliance:

mandatory - This method must be implemented.

setCreditScale

void setCreditScale(Id gradeSystemId)

Sets the credit scale.

Parameters:

gradeSystemId - the new grade system

Throws:

InvalidArgumentException - gradeSystemId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - gradeSystemId is null

Compliance:

mandatory - This method must be implemented.

clearCreditScale

void clearCreditScale()

Clears the credit scale.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getCreditsEarnedMetadata

Metadata getCreditsEarnedMetadata()

Gets the metadata for the credits earned.

Returns:

metadata for the credits earned

Compliance:

mandatory - This method must be implemented.

setCreditsEarned

void setCreditsEarned(BigDecimal credits)

Sets the credits earned.

Parameters:

credits - the new credits

Throws:

InvalidArgumentException - credits is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearCreditsEarned

void clearCreditsEarned()

Clears the credits earned.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getGradeMetadata

Metadata getGradeMetadata()

Gets the metadata for the grade.

Returns:

metadata for the grade

Compliance:

mandatory - This method must be implemented.

setGrade

void setGrade(Id gradeId)

Sets the grade.

Parameters:

gradeId - the new grade

Throws:

InvalidArgumentException - gradeId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - gradeId is null

Compliance:

mandatory - This method must be implemented.

clearGrade

void clearGrade()

Clears the grade.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getScoreScaleMetadata

Metadata getScoreScaleMetadata()

Gets the metadata for the score scale.

Returns:

metadata for the score scale

Compliance:

mandatory - This method must be implemented.

setScoreScale

void setScoreScale(Id gradeSystemId)

Sets the score scale.

Parameters:

gradeSystemId - the new grade system

Throws:

InvalidArgumentException - gradeSystemId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - gradeSystemId is null

Compliance:

mandatory - This method must be implemented.

clearScoreScale

void clearScoreScale()

Clears the score scale.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getScoreMetadata

Metadata getScoreMetadata()

Gets the metadata for the score.

Returns:

metadata for the score

Compliance:

mandatory - This method must be implemented.

setScore

void setScore(BigDecimal score)

Sets the score.

Parameters:

score - the new score

Throws:

InvalidArgumentException - score is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearScore

void clearScore()

Clears the score.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getCourseEntryFormRecord

CourseEntryFormRecord getCourseEntryFormRecord(Type courseEntryRecordType)
                                        throws OperationFailedException

Gets the CourseEntryFormRecord corresponding to the given course entry record Type.

Parameters:

courseEntryRecordType - a course entry record type

Returns:

the course entry form record

Throws:

NullArgumentException - courseEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(courseEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.