org.osid.course.chronicle.batch

Interface ProgramEntryBatchForm

All Superinterfaces:

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

public interface ProgramEntryBatchForm
extends ProgramEntryForm

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

Methods inherited from interface org.osid.course.chronicle.ProgramEntryForm

clearAdmissionDate, clearComplete, clearCreditScale, clearCreditsEarned, clearGPA, clearGPAScale, clearTerm, getAdmissionDateMetadata, getCompleteMetadata, getCreditScaleMetadata, getCreditsEarnedMetadata, getGPAMetadata, getGPAScaleMetadata, getProgramEntryFormRecord, getTermMetadata, setAdmissionDate, setComplete, setCreditScale, setCreditsEarned, setGPA, setGPAScale, 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

getProgramId

Id getProgramId()

Gets the Program Id of the program entry if this is a create transaction.

Returns:

the program Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getStudentId

Id getStudentId()

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

Returns:

the resource Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getProgramEntryId

Id getProgramEntryId()

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

Returns:

the program entry Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.