Interface IdiomBatchForm

All Superinterfaces:

Extensible, Identifiable, IdiomForm, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSubjugateableForm, Suppliable

public interface IdiomBatchForm
extends IdiomForm

This is the form for creating and updating idioms in bulk. Like al l OsidForms , various data elements may be set here for use in the create and update methods in the IdiomBat chAdminSession. 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	getIdiomId()	Gets the Id of the idiom to be updated if this is an update transaction.
Id	getTextId()	Gets the Text Id of the idiom 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 IdiomForm

clearFormatType, clearLanguageType, clearScriptType, clearTemplate, getFormatTypeMetadata, getIdiomFormRecord, getLanguageTypeMetadata, getScriptTypeMetadata, getTemplateMetadata, setFormatType, setLanguageType, setScriptType, setTemplate

Modifier and Type	Method	Description
void	clearFormatType()	Removes the format type.
void	clearLanguageType()	Removes the language type.
void	clearScriptType()	Removes the script type.
void	clearTemplate()	Removes the template.
Metadata	getFormatTypeMetadata()	Gets the metadata for the format type.
IdiomFormRecord	getIdiomFormRecord(Type idiomRecordType)	Gets the IdiomFormRecord corresponding to the given idiom record Type .
Metadata	getLanguageTypeMetadata()	Gets the metadata for the language type.
Metadata	getScriptTypeMetadata()	Gets the metadata for the script type.
Metadata	getTemplateMetadata()	Gets the metadata for the template.
void	setFormatType(Type formatType)	Sets the format type.
void	setLanguageType(Type languageType)	Sets the language type.
void	setScriptType(Type scriptType)	Sets the script type.
void	setTemplate(String template)	Sets the template.

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.

Method Details

getTextId

Id getTextId()

Gets the Text Id of the idiom if this is a create transaction.

Returns:

the text Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getIdiomId

Id getIdiomId()

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

Returns:

the idiom Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.