OSID - osid.lexicon.Idiom Service Interface Definition

Interface	osid.lexicon.Idiom
Implements	`osid.OsidObject`
Implements	`osid.Subjugateable`
Used By	`osid.lexicon.IdiomAdminSession`
	`osid.lexicon.IdiomList`
	`osid.lexicon.IdiomLookupSession`
Description	A `Idiom` is a localized variant of a `Text` .
Method	getTextId
Description	Gets the text `Id` .
Return	`osid.id.Id`		the text `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getText
Description	Gets the text.
Return	`osid.lexicon.Text`		the text
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getLanguageType
Description	Gets the language type.
Return	`osid.type.Type`		the language type
Compliance	`mandatory`		This method must be implemented.
Method	getScriptType
Description	Gets the script type.
Return	`osid.type.Type`		the script type
Compliance	`mandatory`		This method must be implemented.
Method	getFormatType
Description	Gets the format type.
Return	`osid.type.Type`		the format type
Compliance	`mandatory`		This method must be implemented.
Method	getTemplate
Description	Gets the template for this idiom.
Return	`string`		the template
Compliance	`mandatory`		This method must be implemented.
Method	getIdiomRecord
Description	Gets the idiom record corresponding to the given `Idiom` record `Type` .This method is used to retrieve an object implementing the requested record. The `idiomRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(idiomRecordType)` is `true` .
Parameters	`osid.type.Type`	`idiomRecordType`	the type of idiom record to retrieve
Return	`osid.lexicon.records.IdiomRecord`		the idiom 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.