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.

Like all OsidForms, CourseEntryBatchForm is stateful and must not be accessed by multiple processing threads.

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, clearRegistrations, clearScore, clearScoreScale, clearTerm, getCompleteMetadata, getCourseBeginDateMetadata, getCourseEndDateMetadata, getCourseEntryFormRecord, getCreditScaleMetadata, getCreditsEarnedMetadata, getGradeMetadata, getIsRegistrationKnownMetadata, getRegistrationsMetadata, getScoreMetadata, getScoreScaleMetadata, getTermMetadata, setComplete, setCourseBeginDate, setCourseEndDate, setCreditScale, setCreditsEarned, setGrade, setIsRegistrationKnown, setRegistrations, setScore, setScoreScale, setTerm

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Methods inherited from interface Identifiable

getId, isCurrent

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface OsidForm

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

Methods inherited from interface OsidObjectForm

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

Methods inherited from interface OsidRelationshipForm

clearEndReason, getEndReasonMetadata, setEndReason

Methods inherited from interface OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

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.