Interface CourseEntryBatchForm

All Superinterfaces:

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

public interface CourseEntryBatchForm
extends CourseEntryForm

This is the form for creating and updating course entries in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the CourseEntryBatchAdminSession . 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
Id	getCourseEntryId()	Gets the Id of the course entry to be updated if this is an update transaction.
Id	getCourseId()	Gets the Course Id of the course entry if this is a create transaction.
Id	getStudentId()	Gets the student resource Id of the course entry if this is a create transaction.

Methods inherited from interface CourseEntryForm

clearComplete, clearCourseBeginDate, clearCourseEndDate, clearCreditScale, clearCreditsEarned, clearGrade, clearIsRegistrationKnown, clearScore, clearScoreScale, clearTerm, getCompleteMetadata, getCourseBeginDateMetadata, getCourseEndDateMetadata, getCourseEntryFormRecord, getCreditScaleMetadata, getCreditsEarnedMetadata, getGradeMetadata, getIsRegistrationKnownMetadata, getScoreMetadata, getScoreScaleMetadata, getTermMetadata, setComplete, setCourseBeginDate, setCourseEndDate, setCreditScale, setCreditsEarned, setGrade, setIsRegistrationKnown, setScore, setScoreScale, setTerm

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

getCourseId

Id getCourseId()

Gets the Course Id of the course entry if this is a create transaction.

Returns:

the course Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getStudentId

Id getStudentId()

Gets the student resource Id of the course entry if this is a create transaction.

Returns:

the resource Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getCourseEntryId

Id getCourseEntryId()

Gets the Id of the course entry to be updated if this is an update transaction.

Returns:

the course entry Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.