org.osid.course.batch

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

Methods

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

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

Method Detail

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.