Interface TermBatchForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidFederateableForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable, TermForm

public interface TermBatchForm
extends TermForm

This is the form for creating and updating terms in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the TermBatchAdminSession . 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	clearParents()	Removes the hierarchical parents.
Metadata	getParentsMetadata()	Gets the metadata for setting the hierarchical parents of this term.
Id	getTermId()	Gets the Id of the term to be updated if this is an update transaction.
void	setParents(Id[] parents)	Sets the hierarchical parents.

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 TermForm

clearAddDate, clearClassesEnd, clearClassesStart, clearCloseDate, clearDisplayLabel, clearDropDate, clearFinalExamEnd, clearFinalExamStart, clearOpenDate, clearRegistrationEnd, clearRegistrationStart, getAddDateMetadata, getClassesEndMetadata, getClassesStartMetadata, getCloseDateMetadata, getDisplayLabelMetadata, getDropDateMetadata, getFinalExamEndMetadata, getFinalExamStartMetadata, getOpenDateMetadata, getRegistrationEndMetadata, getRegistrationStartMetadata, getTermFormRecord, setAddDate, setClassesEnd, setClassesStart, setCloseDate, setDisplayLabel, setDropDate, setFinalExamEnd, setFinalExamStart, setOpenDate, setRegistrationEnd, setRegistrationStart

Modifier and Type	Method	Description
void	clearAddDate()	Clears the add date.
void	clearClassesEnd()	Clears the classes end date.
void	clearClassesStart()	Clears the classes start date.
void	clearCloseDate()	Clears the close date.
void	clearDisplayLabel()	Removes the display label.
void	clearDropDate()	Clears the drop date.
void	clearFinalExamEnd()	Clears the final exam end date.
void	clearFinalExamStart()	Clears the final exam start date.
void	clearOpenDate()	Clears the open date.
void	clearRegistrationEnd()	Clears the registration end date.
void	clearRegistrationStart()	Clears the registration start date.
Metadata	getAddDateMetadata()	Gets the metadata for the add date.
Metadata	getClassesEndMetadata()	Gets the metadata for the classes end date.
Metadata	getClassesStartMetadata()	Gets the metadata for the classes start date.
Metadata	getCloseDateMetadata()	Gets the metadata for the close date.
Metadata	getDisplayLabelMetadata()	Gets the metadata for a display label title.
Metadata	getDropDateMetadata()	Gets the metadata for the drop date.
Metadata	getFinalExamEndMetadata()	Gets the metadata for the final exam end date.
Metadata	getFinalExamStartMetadata()	Gets the metadata for the classes start date.
Metadata	getOpenDateMetadata()	Gets the metadata for an open date.
Metadata	getRegistrationEndMetadata()	Gets the metadata for the registration end date.
Metadata	getRegistrationStartMetadata()	Gets the metadata for the registration start date.
TermFormRecord	getTermFormRecord(Type termRecordType)	Gets the TermFormRecord corresponding to the given term record Type .
void	setAddDate(DateTime date)	Sets the add date.
void	setClassesEnd(DateTime date)	Sets the classes end date.
void	setClassesStart(DateTime date)	Sets the classes start date.
void	setCloseDate(DateTime date)	Sets the close date.
void	setDisplayLabel(String displayLabel)	Sets the display label.
void	setDropDate(DateTime date)	Sets the drop date.
void	setFinalExamEnd(DateTime date)	Sets the final exam end date.
void	setFinalExamStart(DateTime date)	Sets the final exam start date.
void	setOpenDate(DateTime date)	Sets the open date.
void	setRegistrationEnd(DateTime date)	Sets the registration end date.
void	setRegistrationStart(DateTime date)	Sets the registration start date.

Method Details

getTermId

Id getTermId()

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

Returns:

the term Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.

getParentsMetadata

Metadata getParentsMetadata()

Gets the metadata for setting the hierarchical parents of this term.

Returns:

metadata for the parents

Compliance:

mandatory - This method must be implemented.

setParents

void setParents(Id[] parents)

Sets the hierarchical parents.

Parameters:

parents - the new parents

Throws:

InvalidArgumentException - parents is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - parents is null

Compliance:

mandatory - This method must be implemented.

clearParents

void clearParents()

Removes the hierarchical parents.

Throws:

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

Compliance:

mandatory - This method must be implemented.