org.osid.course.chronicle

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

Methods

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.

Methods inherited from interface org.osid.OsidObjectForm

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

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

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

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

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.

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(java.math.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(java.math.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.