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

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

Methods inherited from interface ProgramEntryForm

clearAdmissionDate, clearComplete, clearCompletionDate, clearCompletionTerm, clearCreditScale, clearCreditsEarned, clearEntranceDate, clearEntranceTerm, clearExpectedCompletionDate, clearExpectedCompletionTerm, clearGPA, clearGPAScale, clearHasWithdrawn, clearIsActivelyEnrolled, clearIsEnrolled, clearIsExpectedToComplete, clearIsMatriculationKnown, clearIsOnLeave, clearLevel, clearStanding, clearTerm, clearWithdrawDate, clearWithdrawTerm, getAdmissionDateMetadata, getCompleteMetadata, getCompletionDateMetadata, getCompletionTermMetadata, getCreditScaleMetadata, getCreditsEarnedMetadata, getEntranceDateMetadata, getEntranceTermMetadata, getExpectedCompletionDateMetadata, getExpectedCompletionTermMetadata, getGPAMetadata, getGPAScaleMetadata, getHasWithdrawnMetadata, getIsActivelyEnrolledMetadata, getIsEnrolledMetadata, getIsExpectedToCompleteMetadata, getIsMatriculationKnownMetadata, getIsOnLeaveMetadata, getLevelMetadata, getProgramEntryFormRecord, getStandingMetadata, getTermMetadata, getWithdrawDateMetadata, getWithdrawTermMetadata, setAdmissionDate, setComplete, setCompletionDate, setCompletionTerm, setCreditScale, setCreditsEarned, setEntranceDate, setEntranceTerm, setExpectedCompletionDate, setExpectedCompletionTerm, setGPA, setGPAScale, setHasWithdrawn, setIsActivelyEnrolled, setIsEnrolled, setIsExpectedToComplete, setIsMatriculationKnown, setIsOnLeave, setLevel, setStanding, setTerm, setWithdrawDate, setWithdrawTerm

Modifier and Type	Method	Description
void	clearAdmissionDate()	Clears the admission date.
void	clearComplete()	Clears the complete flag.
void	clearCompletionDate()	Clears the completion date.
void	clearCompletionTerm()	Clears the completion term.
void	clearCreditScale()	Clears the credit scale.
void	clearCreditsEarned()	Clears the credits earned.
void	clearEntranceDate()	Clears the entrance date.
void	clearEntranceTerm()	Clears the entrance term.
void	clearExpectedCompletionDate()	Clears the expected completion date.
void	clearExpectedCompletionTerm()	Clears the expected completion term.
void	clearGPA()	Clears the gpa.
void	clearGPAScale()	Clears the gpa scale.
void	clearHasWithdrawn()	Clears the has withdrawn flag.
void	clearIsActivelyEnrolled()	Clears the is actively enrolled flag.
void	clearIsEnrolled()	Clears the is enrolled flag.
void	clearIsExpectedToComplete()	Clears the is expected to complete flag.
void	clearIsMatriculationKnown()	Clears the is matriculation known flag.
void	clearIsOnLeave()	Clears the is on leave flag.
void	clearLevel()	Clears the level.
void	clearStanding()	Clears the standing.
void	clearTerm()	Clears the term.
void	clearWithdrawDate()	Clears the withdraw date.
void	clearWithdrawTerm()	Clears the withdraw term.
Metadata	getAdmissionDateMetadata()	Gets the metadata for the admission date.
Metadata	getCompleteMetadata()	Gets the metadta for the completionm flag.
Metadata	getCompletionDateMetadata()	Gets the metadata for the completion date.
Metadata	getCompletionTermMetadata()	Gets the metadata for the completion term.
Metadata	getCreditScaleMetadata()	Gets the metadata for the credit scale.
Metadata	getCreditsEarnedMetadata()	Gets the metadata for the credits earned.
Metadata	getEntranceDateMetadata()	Gets the metadata for the entrance date.
Metadata	getEntranceTermMetadata()	Gets the metadata for the entrance term.
Metadata	getExpectedCompletionDateMetadata()	Gets the metadata for the expected completion date.
Metadata	getExpectedCompletionTermMetadata()	Gets the metadata for the expected completion term.
Metadata	getGPAMetadata()	Gets the metadata for the gpa.
Metadata	getGPAScaleMetadata()	Gets the metadata for the gpa scale.
Metadata	getHasWithdrawnMetadata()	Gets the metadata for the has withdrawn flag.
Metadata	getIsActivelyEnrolledMetadata()	Gets the metadata for the is actively enrolled flag.
Metadata	getIsEnrolledMetadata()	Gets the metadata for the is enrolled flag.
Metadata	getIsExpectedToCompleteMetadata()	Gets the metadata for the is expected to complete flag.
Metadata	getIsMatriculationKnownMetadata()	Gets the metadata for the is matriculation known flag.
Metadata	getIsOnLeaveMetadata()	Gets the metadata for the is on leave flag.
Metadata	getLevelMetadata()	Gets the metadata for the level.
ProgramEntryFormRecord	getProgramEntryFormRecord(Type programEntryRecordType)	Gets the ProgramEntryFormRecord corresponding to the given program entry record Type .
Metadata	getStandingMetadata()	Gets the metadata for the standing.
Metadata	getTermMetadata()	Gets the metadata for the term.
Metadata	getWithdrawDateMetadata()	Gets the metadata for the withdraw date.
Metadata	getWithdrawTermMetadata()	Gets the metadata for the withdraw term.
void	setAdmissionDate(DateTime date)	Sets the admission date.
void	setComplete(boolean complete)	Sets the program is complete flag.
void	setCompletionDate(DateTime date)	Sets the completion date.
void	setCompletionTerm(Id completionTermId)	Sets the completion term.
void	setCreditScale(Id gradeSystemId)	Sets the credit scale.
void	setCreditsEarned(BigDecimal credits)	Sets the credits earned.
void	setEntranceDate(DateTime date)	Sets the entrance date.
void	setEntranceTerm(Id entranceTermId)	Sets the entrance term.
void	setExpectedCompletionDate(DateTime date)	Sets the expected completion date.
void	setExpectedCompletionTerm(Id expectedCompletionTermId)	Sets the expected completion term.
void	setGPA(BigDecimal gpa)	Sets the gpa.
void	setGPAScale(Id gradeSystemId)	Sets the gpa scale.
void	setHasWithdrawn(boolean hasWithdrawn)	Sets the has withdrawn flag.
void	setIsActivelyEnrolled(boolean isActivelyEnrolled)	Sets the is actively enrolled flag.
void	setIsEnrolled(boolean isEnrolled)	Sets the is enrolled flag.
void	setIsExpectedToComplete(boolean isExpectedToComplete)	Sets the is expected to complete flag.
void	setIsMatriculationKnown(boolean isMatriculationKnown)	Sets the is matriculation known flag.
void	setIsOnLeave(boolean isOnLeave)	Sets the is on leave flag.
void	setLevel(Id levelId)	Sets the level.
void	setStanding(Id standingId)	Sets the standing.
void	setTerm(Id termId)	Sets the term.
void	setWithdrawDate(DateTime date)	Sets the withdraw date.
void	setWithdrawTerm(Id withdrawTermId)	Sets the withdraw term.

Method Details

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.