org.osid.course.chronicle

Interface ProgramEntryForm

All Superinterfaces:

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

All Known Subinterfaces:

ProgramEntryBatchForm

public interface ProgramEntryForm
extends OsidRelationshipForm

This is the form for creating and updating ProgramEntries. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ProgramEntryAdminSession. 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	clearAdmissionDate() Clears the admission date.
void	clearComplete() Clears the complete flag.
void	clearCreditScale() Clears the credit scale.
void	clearCreditsEarned() Clears the credits earned.
void	clearGPA() Clears the gpa.
void	clearGPAScale() Clears the gpa scale.
void	clearTerm() Clears the term.
Metadata	getAdmissionDateMetadata() Gets the metadata for the admission date.
Metadata	getCompleteMetadata() Gets the metadta for the completionm flag.
Metadata	getCreditScaleMetadata() Gets the metadata for the credit scale.
Metadata	getCreditsEarnedMetadata() Gets the metadata for the credits earned.
Metadata	getGPAMetadata() Gets the metadata for the gpa.
Metadata	getGPAScaleMetadata() Gets the metadata for the gpa scale.
ProgramEntryFormRecord	getProgramEntryFormRecord(Type programEntryRecordType) Gets the ProgramEntryFormRecord corresponding to the given program entry record Type.
Metadata	getTermMetadata() Gets the metadata for the term.
void	setAdmissionDate(DateTime date) Sets the admission date.
void	setComplete(boolean complete) Sets the program is complete flag.
void	setCreditScale(Id gradeSystemId) Sets the credit scale.
void	setCreditsEarned(java.math.BigDecimal credits) Sets the credits earned.
void	setGPA(java.math.BigDecimal gpa) Sets the gpa.
void	setGPAScale(Id gradeSystemId) Sets the gpa scale.
void	setTerm(Id termId) Sets the term.

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

getAdmissionDateMetadata

Metadata getAdmissionDateMetadata()

Gets the metadata for the admission date.

Returns:

metadata for the admission date

Compliance:

mandatory - This method must be implemented.

setAdmissionDate

void setAdmissionDate(DateTime date)

Sets the admission 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.

clearAdmissionDate

void clearAdmissionDate()

Clears the admission date.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getCompleteMetadata

Metadata getCompleteMetadata()

Gets the metadta for the completionm flag.

Returns:

metadata for the complete flag

Compliance:

mandatory - This method must be implemented.

setComplete

void setComplete(boolean complete)

Sets the program is complete flag.

Parameters:

complete - the new complete flag

Throws:

InvalidArgumentException - complete is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearComplete

void clearComplete()

Clears the complete flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getTermMetadata

Metadata getTermMetadata()

Gets the metadata for the term.

Returns:

metadata for the term

Compliance:

mandatory - This method must be implemented.

setTerm

void setTerm(Id termId)

Sets the term.

Parameters:

termId - the new term

Throws:

InvalidArgumentException - termId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - termId is null

Compliance:

mandatory - This method must be implemented.

clearTerm

void clearTerm()

Clears the term.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getCreditScaleMetadata

Metadata getCreditScaleMetadata()

Gets the metadata for the credit scale.

Returns:

metadata for the credit scale

Compliance:

mandatory - This method must be implemented.

setCreditScale

void setCreditScale(Id gradeSystemId)

Sets the credit scale.

Parameters:

gradeSystemId - the new grade system

Throws:

InvalidArgumentException - gradeSystemId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - gradeSystemId is null

Compliance:

mandatory - This method must be implemented.

clearCreditScale

void clearCreditScale()

Clears the credit scale.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getCreditsEarnedMetadata

Metadata getCreditsEarnedMetadata()

Gets the metadata for the credits earned.

Returns:

metadata for the credits earned

Compliance:

mandatory - This method must be implemented.

setCreditsEarned

void setCreditsEarned(java.math.BigDecimal credits)

Sets the credits earned.

Parameters:

credits - the new credits

Throws:

InvalidArgumentException - credits is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearCreditsEarned

void clearCreditsEarned()

Clears the credits earned.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getGPAScaleMetadata

Metadata getGPAScaleMetadata()

Gets the metadata for the gpa scale.

Returns:

metadata for the gpa scale

Compliance:

mandatory - This method must be implemented.

setGPAScale

void setGPAScale(Id gradeSystemId)

Sets the gpa scale.

Parameters:

gradeSystemId - the new grade system

Throws:

InvalidArgumentException - gradeSystemId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - gradeSystemId is null

Compliance:

mandatory - This method must be implemented.

clearGPAScale

void clearGPAScale()

Clears the gpa scale.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getGPAMetadata

Metadata getGPAMetadata()

Gets the metadata for the gpa.

Returns:

metadata for the gpa

Compliance:

mandatory - This method must be implemented.

setGPA

void setGPA(java.math.BigDecimal gpa)

Sets the gpa.

Parameters:

gpa - the new gpa

Throws:

InvalidArgumentException - gpa is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearGPA

void clearGPA()

Clears the gpa.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getProgramEntryFormRecord

ProgramEntryFormRecord getProgramEntryFormRecord(Type programEntryRecordType)
                                                 throws OperationFailedException

Gets the ProgramEntryFormRecord corresponding to the given program entry record Type.

Parameters:

programEntryRecordType - a program entry record type

Returns:

the program entry form record

Throws:

NullArgumentException - programEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(programEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.