OSID - osid.lexicon.IdiomForm Service Interface Definition

Interface	osid.lexicon.IdiomForm
Implements	`osid.OsidObjectForm`
Implements	`osid.OsidSubjugateableForm`
Implemented By	`osid.lexicon.batch.IdiomBatchForm`
Used By	`osid.lexicon.IdiomAdminSession`
Description	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	getLanguageTypeMetadata
Description	Gets the metadata for the language type.
Return	`osid.Metadata`		metadata for the language type
Compliance	`mandatory`		This method must be implemented.
Method	setLanguageType
Description	Sets the language type.
Parameters	`osid.type.Type`	`languageType`	the new language type
Errors	INVALID_ARGUMENT		`languageType` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`languageType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLanguageType
Description	Removes the language type.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getScriptTypeMetadata
Description	Gets the metadata for the script type.
Return	`osid.Metadata`		metadata for the script type
Compliance	`mandatory`		This method must be implemented.
Method	setScriptType
Description	Sets the script type.
Parameters	`osid.type.Type`	`scriptType`	the new script type
Errors	INVALID_ARGUMENT		`scriptType` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`scriptType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearScriptType
Description	Removes the script type.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getFormatTypeMetadata
Description	Gets the metadata for the format type.
Return	`osid.Metadata`		metadata for the format type
Compliance	`mandatory`		This method must be implemented.
Method	setFormatType
Description	Sets the format type.
Parameters	`osid.type.Type`	`formatType`	the new format type
Errors	INVALID_ARGUMENT		`formatType` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`formatType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearFormatType
Description	Removes the format type.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTemplateMetadata
Description	Gets the metadata for the template.
Return	`osid.Metadata`		metadata for the template
Compliance	`mandatory`		This method must be implemented.
Method	setTemplate
Description	Sets the template.
Parameters	`string`	`template`	the new template
Errors	INVALID_ARGUMENT		`template` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`template` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTemplate
Description	Removes the template.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getIdiomFormRecord
Description	Gets the `IdiomFormRecord` corresponding to the given idiom record `Type`.
Parameters	`osid.type.Type`	`idiomRecordType`	an idiom record type
Return	`osid.lexicon.records.IdiomFormRecord`		the idiom form record
Errors	NULL_ARGUMENT		`idiomRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(idiomRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.