Interface IdiomForm

All Superinterfaces:

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

All Known Subinterfaces:

IdiomBatchForm

public interface IdiomForm
extends OsidObjectForm, OsidSubjugateableForm

This is the form for creating and updating Idioms. Like all OsidForms, various data elements may be set here for use in the create and update methods in the IdiomAdminSession. 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	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 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.

Method Details

getLanguageTypeMetadata

Metadata getLanguageTypeMetadata()

Gets the metadata for the language type.

Returns:

metadata for the language type

Compliance:

mandatory - This method must be implemented.

setLanguageType

void setLanguageType(Type languageType)

Sets the language type.

Parameters:

languageType - the new language type

Throws:

InvalidArgumentException - languageType is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - languageType is null

Compliance:

mandatory - This method must be implemented.

clearLanguageType

void clearLanguageType()

Removes the language type.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getScriptTypeMetadata

Metadata getScriptTypeMetadata()

Gets the metadata for the script type.

Returns:

metadata for the script type

Compliance:

mandatory - This method must be implemented.

setScriptType

void setScriptType(Type scriptType)

Sets the script type.

Parameters:

scriptType - the new script type

Throws:

InvalidArgumentException - scriptType is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - scriptType is null

Compliance:

mandatory - This method must be implemented.

clearScriptType

void clearScriptType()

Removes the script type.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getFormatTypeMetadata

Metadata getFormatTypeMetadata()

Gets the metadata for the format type.

Returns:

metadata for the format type

Compliance:

mandatory - This method must be implemented.

setFormatType

void setFormatType(Type formatType)

Sets the format type.

Parameters:

formatType - the new format type

Throws:

InvalidArgumentException - formatType is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - formatType is null

Compliance:

mandatory - This method must be implemented.

clearFormatType

void clearFormatType()

Removes the format type.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getTemplateMetadata

Metadata getTemplateMetadata()

Gets the metadata for the template.

Returns:

metadata for the template

Compliance:

mandatory - This method must be implemented.

setTemplate

void setTemplate(String template)

Sets the template.

Parameters:

template - the new template

Throws:

InvalidArgumentException - template is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - template is null

Compliance:

mandatory - This method must be implemented.

clearTemplate

void clearTemplate()

Removes the template.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getIdiomFormRecord

IdiomFormRecord getIdiomFormRecord(Type idiomRecordType)
                            throws OperationFailedException

Gets the IdiomFormRecord corresponding to the given idiom record Type.

Parameters:

idiomRecordType - an idiom record type

Returns:

the idiom form record

Throws:

NullArgumentException - idiomRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(idiomRecordType) is false

Compliance:

mandatory - This method must be implemented.