com.sap.dictionary.runtime
Interface IDataType

All Superinterfaces:

java.lang.Cloneable

All Known Subinterfaces:

IList, ISimpleType, ISimpleTypeModifiable, IStructure

public interface IDataType

extends java.lang.Cloneable

Method Summary

java.lang.Class	getAssociatedClass() Returns the corresponding Class object for the SimpleType, e.g.
com.sap.dictionary.runtime.IBackendConversionRule	getBackendConversionRule() Returns the backend conversion rule for this DataType.
java.lang.String	getBackendName() If the DataType is read from a non java-backend, a backend name exists and is delivered.
java.util.Locale	getLocale() Returns the locale of this DataType.
java.lang.String	getLocalName() Returns the unqualified name for this DataType, excluding the package, e.g text_simpletype for com.sap.abc.test_simpletype
java.lang.String	getName() Returns the name for this DataType, including the package, e.g com.sap.abc.test_simpletype
java.lang.String	getPrefix() Returns the type's package, e.g com.sap.abc for com.sap.abc.test_simpletype
java.lang.String	getQualifiedName() Returns the name for this DataType, including the package, e.g com.sap.abc.test_simpletype
boolean	isModifyAllowed() SimpleTypes are unchangable by default but can be cloned to changeable copies.
boolean	isSimpleType() Returns true if this DataType is a SimpleType, false otherwise.
boolean	isStructure() Returns true if this data type is a structure, false otherwise.

Method Detail

getName

public java.lang.String getName()

Returns the name for this DataType, including the package, e.g com.sap.abc.test_simpletype

Returns:

the type's qualified name

getLocalName

public java.lang.String getLocalName()

Returns the unqualified name for this DataType, excluding the package, e.g text_simpletype for com.sap.abc.test_simpletype

Returns:

the type's unqualified name

getPrefix

public java.lang.String getPrefix()

Returns the type's package, e.g com.sap.abc for com.sap.abc.test_simpletype

Returns:

the type's package

getBackendName

public java.lang.String getBackendName()

If the DataType is read from a non java-backend, a backend name exists and is delivered.

Returns:

the type's backend name, if existing

getLocale

public java.util.Locale getLocale()

Returns the locale of this DataType. The locale controls in which language the type's texts are delivered and the format and parse methods.

getAssociatedClass

public java.lang.Class getAssociatedClass()

Returns the corresponding Class object for the SimpleType, e.g. Date.class in case the builtInType is date, String.class if the builtInType is string.

Returns:

the corresponding Class object

isModifyAllowed

public boolean isModifyAllowed()

SimpleTypes are unchangable by default but can be cloned to changeable copies. Wether you are working with an original unchangable SimpleType or a changable copy is delivered here. A structure can not be modified at all.

Returns:

true, if the DataType can be modified, false otherwise

isSimpleType

public boolean isSimpleType()

Returns true if this DataType is a SimpleType, false otherwise.

isStructure

public boolean isStructure()

Returns true if this data type is a structure, false otherwise.

getQualifiedName

public java.lang.String getQualifiedName()

Returns the name for this DataType, including the package, e.g com.sap.abc.test_simpletype

Returns:

the type's qualified name

getBackendConversionRule

public com.sap.dictionary.runtime.IBackendConversionRule getBackendConversionRule()

Returns the backend conversion rule for this DataType. For more information see interface com.sap.dictionary.types.services. IBackendConversionRule. This interface carries all information for converting data of a backend DataType to data of a frontend DataType

Returns:

a backend conversion rule