org.osid.course.chronicle

Interface AwardEntryForm

All Superinterfaces:

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

All Known Subinterfaces:

AwardEntryBatchForm

public interface AwardEntryForm
extends OsidRelationshipForm

This is the form for creating and updating AwardEntries. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the AwardEntryAdminSession. 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
void	clearAssessment() Clears the assessment.
void	clearCourse() Clears the course.
void	clearDateAwarded() Clears the award date.
void	clearProgram() Clears the program.
Metadata	getAssessmentMetadata() Gets the metadata for the assessment.
AwardEntryFormRecord	getAwardEntryFormRecord(Type awardEntryRecordType) Gets the AwardEntryFormRecord corresponding to the given award entry record Type.
Metadata	getCourseMetadata() Gets the metadata for the course.
Metadata	getDateAwardedMetadata() Gets the metadata for the award date.
Metadata	getProgramMetadata() Gets the metadata for the program.
void	setAssessment(Id assessmentId) Sets the assessment.
void	setCourse(Id courseId) Sets the course.
void	setDateAwarded(DateTime date) Sets the award date.
void	setProgram(Id programId) Sets the program.

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

getDateAwardedMetadata

Metadata getDateAwardedMetadata()

Gets the metadata for the award date.

Returns:

metadata for the award date

Compliance:

mandatory - This method must be implemented.

setDateAwarded

void setDateAwarded(DateTime date)

Sets the award date.

Parameters:

date - the new date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearDateAwarded

void clearDateAwarded()

Clears the award date.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getProgramMetadata

Metadata getProgramMetadata()

Gets the metadata for the program.

Returns:

metadata for the program

Compliance:

mandatory - This method must be implemented.

setProgram

void setProgram(Id programId)

Sets the program.

Parameters:

programId - the new program

Throws:

InvalidArgumentException - programId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - programId is null

Compliance:

mandatory - This method must be implemented.

clearProgram

void clearProgram()

Clears the program.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getCourseMetadata

Metadata getCourseMetadata()

Gets the metadata for the course.

Returns:

metadata for the course

Compliance:

mandatory - This method must be implemented.

setCourse

void setCourse(Id courseId)

Sets the course.

Parameters:

courseId - the new course

Throws:

InvalidArgumentException - courseId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - courseId is null

Compliance:

mandatory - This method must be implemented.

clearCourse

void clearCourse()

Clears the course.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getAssessmentMetadata

Metadata getAssessmentMetadata()

Gets the metadata for the assessment.

Returns:

metadata for the assessment

Compliance:

mandatory - This method must be implemented.

setAssessment

void setAssessment(Id assessmentId)

Sets the assessment.

Parameters:

assessmentId - the new assessment

Throws:

InvalidArgumentException - assessmentId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - assessmentId is null

Compliance:

mandatory - This method must be implemented.

clearAssessment

void clearAssessment()

Clears the assessment.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getAwardEntryFormRecord

AwardEntryFormRecord getAwardEntryFormRecord(Type awardEntryRecordType)
                                             throws OperationFailedException

Gets the AwardEntryFormRecord corresponding to the given award entry record Type.

Parameters:

awardEntryRecordType - an award entry record type

Returns:

the award entry form record

Throws:

NullArgumentException - awardEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(awardEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.