OSID Logo
OSID Specifications
lexicon package
Version 3.1.0
Interfaceosid.lexicon.Idiom
Implementsosid.OsidObject
osid.Subjugateable
Used Byosid.lexicon.IdiomAdminSession
osid.lexicon.IdiomList
osid.lexicon.IdiomLookupSession
Description

A Idiom is a localized variant of a Text.

MethodgetTextId
Description

Gets the text Id.

Returnosid.id.Id the text Id
Compliancemandatory This method must be implemented.
MethodgetText
Description

Gets the text.

Returnosid.lexicon.Text the text
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetLanguageType
Description

Gets the language type.

Returnosid.type.Type the language type
Compliancemandatory This method must be implemented.
MethodgetScriptType
Description

Gets the script type.

Returnosid.type.Type the script type
Compliancemandatory This method must be implemented.
MethodgetFormatType
Description

Gets the format type.

Returnosid.type.Type the format type
Compliancemandatory This method must be implemented.
MethodgetTemplate
Description

Gets the template for this idiom.

Returnstring the template
Compliancemandatory This method must be implemented.
MethodgetIdiomRecord
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.

Parametersosid.type.TypeidiomRecordType the type of idiom record to retrieve
Returnosid.lexicon.records.IdiomRecord the idiom record
ErrorsNULL_ARGUMENT idiomRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(idiomRecordType) is false
Compliancemandatory This method must be implemented.