org.osid.course.chronicle.batch

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

Methods

Modifier and Type	Method and 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 org.osid.course.chronicle.CourseEntryForm

clearComplete, clearCreditScale, clearCreditsEarned, clearGrade, clearScore, clearScoreScale, clearTerm, getCompleteMetadata, getCourseEntryFormRecord, getCreditScaleMetadata, getCreditsEarnedMetadata, getGradeMetadata, getScoreMetadata, getScoreScaleMetadata, getTermMetadata, setComplete, setCreditScale, setCreditsEarned, setGrade, setScore, setScoreScale, setTerm

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

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.