org.osid.course.chronicle.batch

Interface AwardEntryBatchForm

All Superinterfaces:

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

public interface AwardEntryBatchForm
extends AwardEntryForm

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

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

clearAssessment, clearCourse, clearDateAwarded, clearProgram, getAssessmentMetadata, getAwardEntryFormRecord, getCourseMetadata, getDateAwardedMetadata, getProgramMetadata, setAssessment, setCourse, setDateAwarded, setProgram

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

getAwardId

Id getAwardId()

Gets the Award Id of the award entry if this is a create transaction.

Returns:

the award Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getStudentId

Id getStudentId()

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

Returns:

the resource Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getAwardEntryId

Id getAwardEntryId()

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

Returns:

the award entry Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.