Interface Idiom

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, Subjugateable

public interface Idiom
extends OsidObject, Subjugateable

A Idiom is a localized variant of a Text .

Method Summary

Modifier and Type	Method	Description
Type	getFormatType()	Gets the format type.
IdiomRecord	getIdiomRecord(Type idiomRecordType)	Gets the idiom record corresponding to the given Idiom record Type .This method is used to retrieve an object implementing the requested record.
Type	getLanguageType()	Gets the language type.
Type	getScriptType()	Gets the script type.
String	getTemplate()	Gets the template for this idiom.
Text	getText()	Gets the text.
Id	getTextId()	Gets the text Id .

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Modifier and Type	Method	Description
DisplayText	getDescription()	Gets the description associated with this instance of this OSID object.
DisplayText	getDisplayName()	Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.
Type	getGenusType()	Gets the genus type of this object.
boolean	isOfGenusType(Type genusType)	Tests if this object is of the given genus Type .

Method Details

getTextId

Id getTextId()

Gets the text Id .

Returns:

the text Id

Compliance:

mandatory - This method must be implemented.

getText

Text getText()
      throws OperationFailedException

Gets the text.

Returns:

the text

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getLanguageType

Type getLanguageType()

Gets the language type.

Returns:

the language type

Compliance:

mandatory - This method must be implemented.

getScriptType

Type getScriptType()

Gets the script type.

Returns:

the script type

Compliance:

mandatory - This method must be implemented.

getFormatType

Type getFormatType()

Gets the format type.

Returns:

the format type

Compliance:

mandatory - This method must be implemented.

getTemplate

String getTemplate()

Gets the template for this idiom.

Returns:

the template

Compliance:

mandatory - This method must be implemented.

getIdiomRecord

IdiomRecord getIdiomRecord(Type idiomRecordType)
                    throws OperationFailedException

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:

idiomRecordType - the type of idiom record to retrieve

Returns:

the idiom record

Throws:

NullArgumentException - idiomRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(idiomRecordType) is false

Compliance:

mandatory - This method must be implemented.