Interface CredentialEntryBatchForm

All Superinterfaces:

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

public interface CredentialEntryBatchForm
extends CredentialEntryForm

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

Methods inherited from interface CredentialEntryForm

clearAbandonDate, clearAbandonTerm, clearAwardDate, clearAwardTerm, clearDateAwarded, clearExpectedCompletionDate, clearExpectedCompletionTerm, clearIsAbandoned, clearIsActivelyPursuing, clearIsAwarded, clearIsExpectedToComplete, clearIsMatriculationKnown, clearIsPaused, clearProgram, clearStartDate, clearStartTerm, getAbandonDateMetadata, getAbandonTermMetadata, getAwardDateMetadata, getAwardTermMetadata, getCredentialEntryFormRecord, getDateAwardedMetadata, getExpectedCompletionDateMetadata, getExpectedCompletionTermMetadata, getIsAbandonedMetadata, getIsActivelyPursuingMetadata, getIsAwardedMetadata, getIsExpectedToCompleteMetadata, getIsMatriculationKnownMetadata, getIsPausedMetadata, getProgramMetadata, getStartDateMetadata, getStartTermMetadata, setAbandonDate, setAbandonTerm, setAwardDate, setAwardTerm, setDateAwarded, setExpectedCompletionDate, setExpectedCompletionTerm, setIsAbandoned, setIsActivelyPursuing, setIsAwarded, setIsExpectedToComplete, setIsMatriculationKnown, setIsPaused, setProgram, setStartDate, setStartTerm

Modifier and Type	Method	Description
void	clearAbandonDate()	Clears the abandon date.
void	clearAbandonTerm()	Clears the abandon term.
void	clearAwardDate()	Clears the award date.
void	clearAwardTerm()	Clears the award term.
void	clearDateAwarded()	Clears the award date.
void	clearExpectedCompletionDate()	Clears the expected completion date.
void	clearExpectedCompletionTerm()	Clears the expected completion term.
void	clearIsAbandoned()	Clears the is abandoned flag.
void	clearIsActivelyPursuing()	Clears the is actively pursuing flag.
void	clearIsAwarded()	Clears the is awarded flag.
void	clearIsExpectedToComplete()	Clears the is expected to complete flag.
void	clearIsMatriculationKnown()	Clears the is matriculation known flag.
void	clearIsPaused()	Clears the is paused flag.
void	clearProgram()	Clears the program.
void	clearStartDate()	Clears the start date.
void	clearStartTerm()	Clears the start term.
Metadata	getAbandonDateMetadata()	Gets the metadata for the abandon date.
Metadata	getAbandonTermMetadata()	Gets the metadata for the abandon term.
Metadata	getAwardDateMetadata()	Gets the metadata for the award date.
Metadata	getAwardTermMetadata()	Gets the metadata for the award term.
CredentialEntryFormRecord	getCredentialEntryFormRecord(Type credentialEntryRecordType)	Gets the CredentialEntryFormRecord corresponding to the given credential entry record Type .
Metadata	getDateAwardedMetadata()	Gets the metadata for the award date.
Metadata	getExpectedCompletionDateMetadata()	Gets the metadata for the expected completion date.
Metadata	getExpectedCompletionTermMetadata()	Gets the metadata for the expected completion term.
Metadata	getIsAbandonedMetadata()	Gets the metadata for the is abandoned flag.
Metadata	getIsActivelyPursuingMetadata()	Gets the metadata for the is actively pursuing flag.
Metadata	getIsAwardedMetadata()	Gets the metadata for the is awarded 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	getIsPausedMetadata()	Gets the metadata for the is paused flag.
Metadata	getProgramMetadata()	Gets the metadata for the program.
Metadata	getStartDateMetadata()	Gets the metadata for the start date.
Metadata	getStartTermMetadata()	Gets the metadata for the start term.
void	setAbandonDate(DateTime date)	Sets the abandon date.
void	setAbandonTerm(Id abandonTermId)	Sets the abandon term.
void	setAwardDate(DateTime date)	Sets the award date.
void	setAwardTerm(Id awardTermId)	Sets the award term.
void	setDateAwarded(DateTime date)	Sets the award date.
void	setExpectedCompletionDate(DateTime date)	Sets the expected completion date.
void	setExpectedCompletionTerm(Id expectedCompletionTermId)	Sets the expected completion term.
void	setIsAbandoned(boolean isAbandoned)	Sets the is abandoned flag.
void	setIsActivelyPursuing(boolean isActivelyPursuing)	Sets the is actively pursuing flag.
void	setIsAwarded(boolean isAwarded)	Sets the is awarded flag.
void	setIsExpectedToComplete(boolean isExpectedToComplete)	Sets the is expected to complete flag.
void	setIsMatriculationKnown(boolean isMatriculationKnown)	Sets the is matriculation known flag.
void	setIsPaused(boolean isPaused)	Sets the is paused flag.
void	setProgram(Id programId)	Sets the program.
void	setStartDate(DateTime date)	Sets the start date.
void	setStartTerm(Id startTermId)	Sets the start term.

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, getEndDateMetadata, setEndDate

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

Method Details

getCredentialId

Id getCredentialId()

Gets the Credential Id of the credential entry if this is a create transaction.

Returns:

the credential Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getStudentid

Id getStudentid()

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

Returns:

the resource Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getCredentialEntryId

Id getCredentialEntryId()

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

Returns:

the credential entry Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.