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

Modifier and Type	Method	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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm.

Methods inherited from interface OsidForm

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

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

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

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Methods inherited from interface OsidRelationshipForm

clearEndReason, getEndReasonMetadata, setEndReason

Modifier and Type	Method	Description
void	clearEndReason()	Removes the end reason.
Metadata	getEndReasonMetadata()	Gets the metadata for the end reason.
void	setEndReason(Id stateId)	Sets the end reason.

Methods inherited from interface OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Modifier and Type	Method	Description
void	clearEndDate()	Clears the end date.
void	clearStartDate()	Clears the start date.
Metadata	getEndDateMetadata()	Gets the metadata for an end date.
Metadata	getStartDateMetadata()	Gets the metadata for a start date.
void	setEndDate(DateTime date)	Sets the end date.
void	setStartDate(DateTime date)	Sets the start date.

Method Details

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.