SimpleType (SAP Cloud Platform - Server OData API for Mobile Services)

java.lang.Object
- com.sap.cloud.server.odata.DataType
- - com.sap.cloud.server.odata.SimpleType

```
public class SimpleType
extends DataType
```
Represents a type definition for an underlying basic type.

Field Summary

Fields
Modifier and Type Field and Description

static EnumType simplr
- Fields inherited from class com.sap.cloud.server.odata.DataType
  ANNOTATION_PATH, BINARY, BOOLEAN, BYTE, BYTE_STREAM, CHAR, CHAR_STREAM, CODE_UNKNOWN, COMPLEX_VALUE, COMPLEX_VALUE_LIST, DATA_VALUE_LIST, DAY_TIME_DURATION, DECIMAL, DELTA_STREAM, DOUBLE, DYNAMIC_PATH, EDM_PRIMITIVE, ENTITY_VALUE, ENTITY_VALUE_LIST, ENUM_VALUE, FLOAT, GEOGRAPHY_COLLECTION, GEOGRAPHY_LINE_STRING, GEOGRAPHY_MULTI_LINE_STRING, GEOGRAPHY_MULTI_POINT, GEOGRAPHY_MULTI_POLYGON, GEOGRAPHY_POINT, GEOGRAPHY_POLYGON, GEOGRAPHY_VALUE, GEOMETRY_COLLECTION, GEOMETRY_LINE_STRING, GEOMETRY_MULTI_LINE_STRING, GEOMETRY_MULTI_POINT, GEOMETRY_MULTI_POLYGON, GEOMETRY_POINT, GEOMETRY_POLYGON, GEOMETRY_VALUE, GLOBAL_DATE_TIME, GUID_VALUE, INT, INTEGER, LIST, LOCAL_DATE, LOCAL_DATE_TIME, LOCAL_TIME, LONG, NAVIGATION_PATH, OBJECT, PATH, PATH_EXPRESSION, PROPERTY_PATH, QUERY_ALIAS, QUERY_FILTER, QUERY_FUNCTION_CALL, QUERY_OPERATOR_CALL, SHORT, STREAM_LINK, STRING, STRUCTURAL_PATH, TARGET_PATH, unknown, UNSIGNED_BYTE, UNSIGNED_INT, UNSIGNED_LONG, UNSIGNED_SHORT, YEAR_MONTH_DURATION

Fields
Modifier and Type	Field and Description
`static EnumType`	`simplr`

Constructor Summary

Constructors
Constructor and Description

SimpleType()

Constructors
Constructor and Description
`SimpleType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Annotation`	`getAnnotation(java.lang.String term)` Lookup an existing annotation by term name, or throw an exception if the annotation is not found.
`AnnotationMap`	`getAnnotations()` Return map of annotations for this model element.
`boolean`	`getCanBeRemoved()` Return can this model element be removed by `DataService.refreshMetadata`.
`int`	`getCode()` Return the type code of the underlying type.
`DataType`	`getDerivedFrom()` Return synonym for `SimpleType.baseType`.
`boolean`	`getFixedLength()` Return `true` if this item has fixed length for `string` and `binary` values.
`java.lang.String`	`getLocalName()` Return the local name of this type within its owning `DataSchema`, e.g.
`int`	`getMaxLength()` Return maximum length for `string` and `binary` values.
`int`	`getMinLength()` Return minimum length for `string` and `binary` values.
`java.lang.String`	`getName()` Return synonym for `SimpleType.qualifiedName`.
`int`	`getPrecision()` Return precision for `decimal` and `integer` values.
`java.lang.String`	`getQualifiedName()` Return the name of this type qualified by its owning `DataSchema` name, e.g.
`int`	`getScale()` Return scale for `decimal` values.
`int`	`getSourceLine()` Return source line number for this schema element within its defining schema.
`int`	`getSrid()` Return EPSG Spatial Reference System Identifier (SRID) for the associated value.
`TypeFacets`	`getTypeFacets()` Return (nullable) Type facets for this type.
`boolean`	`isDerived()` Return `true` if this type is a derived simple, complex, entity or enum type.
`boolean`	`isExtension()` Return `true` if this type was added since metadata was originally loaded.
`boolean`	`isInferred()` Return `true` if this simple type was inferred due to a missing term definition in the CSDL.
`boolean`	`isRemoved()` Return has this model element been removed by a successful call to `DataService.refreshMetadata`? If `isRemoved == true, that implies that the old metadata (before refreshMetadata was called) did include this model element, and that the new metadata (after refreshMetadata was called) does not include this model element.
`boolean`	`isUnicode()` Return `true` if this item allows Unicode content.
`void`	`setCanBeRemoved(boolean value)` Set can this model element be removed by `DataService.refreshMetadata`.
`void`	`setDerivedFrom(DataType value)` Set synonym for `SimpleType.baseType`.
`void`	`setExtension(boolean value)` Set `true` if this type was added since metadata was originally loaded.
`void`	`setInferred(boolean value)` Set `true` if this simple type was inferred due to a missing term definition in the CSDL.
`void`	`setLocalName(java.lang.String value)` Set the local name of this type within its owning `DataSchema`, e.g.
`void`	`setMaxLength(int value)` Set maximum length for `string` and `binary` values.
`void`	`setMinLength(int value)` Set minimum length for `string` and `binary` values.
`void`	`setPrecision(int value)` Set precision for `decimal` and `integer` values.
`void`	`setQualifiedName(java.lang.String value)` Set the name of this type qualified by its owning `DataSchema` name, e.g.
`void`	`setRemoved(boolean value)` Set has this model element been removed by a successful call to `DataService.refreshMetadata`? If `isRemoved == true, that implies that the old metadata (before refreshMetadata was called) did include this model element, and that the new metadata (after refreshMetadata was called) does not include this model element.
`void`	`setScale(int value)` Set scale for `decimal` values.
`void`	`setSourceLine(int value)` Set source line number for this schema element within its defining schema.
`void`	`setSrid(int value)` Set EPSG Spatial Reference System Identifier (SRID) for the associated value.
`void`	`setTypeFacets(TypeFacets value)` Set type facets for this type.
`void`	`setUnicode(boolean value)` Set `true` if this item allows Unicode content.
`java.lang.String`	`toString()` Return the name of this data type.

Methods inherited from class com.sap.cloud.server.odata.DataType
forCode, forName, getBaseType, getItemType, isBasic, isBasicList, isCalendar, isComplex, isComplexList, isEntity, isEntityList, isEnum, isEnumList, isGeography, isGeometry, isGeospatial, isGuid, isList, isNumber, isPath, isStream, isUnsigned, listOf

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - simplr
```
public static final EnumType simplr
```
- Constructor Detail
  - SimpleType
```
public SimpleType()
```
- Method Detail
  - getAnnotation
```
public Annotation getAnnotation(java.lang.String term)
```
    Lookup an existing annotation by term name, or throw an exception if the annotation is not found.
    
    See Also:
    
    SimpleType.annotations and AnnotationMap.get, for looking up annotations that might not exist.
    
    Parameters:
    
    term - The term name.
    
    Returns:
    
    The annotation.
  - getAnnotations
```
public AnnotationMap getAnnotations()
```
    Return map of annotations for this model element. For annotations without qualifiers, the entry key is the annotation term name. For annotations with qualifiers, the entry key is the annotation term name, then "#", then the annotation qualifier.
    
    See Also:
    
    Annotation, AnnotationTerm.
    
    Returns:
    
    Map of annotations for this model element.
  - getCanBeRemoved
```
public boolean getCanBeRemoved()
```
    Return can this model element be removed by DataService.refreshMetadata. Defaults to false. Set this to true to indicate that the application is coded to be able able to function correctly without this model element.
    
    See Also:
    
    SimpleType.isRemoved.
    
    Returns:
    
    Can this model element be removed by `DataService.refreshMetadata`. Defaults to `false`.
  - getCode
```
public int getCode()
```
    Return the type code of the underlying type.
    
    Overrides:
    
    getCode in class DataType
    
    Returns:
    
    The type code of the underlying type.
  - getDerivedFrom
```
public DataType getDerivedFrom()
```
    Return synonym for SimpleType.baseType.
    
    Returns:
    
    Synonym for SimpleType.baseType.
  - getFixedLength
```
public boolean getFixedLength()
```
    Return true if this item has fixed length for string and binary values.
    
    See Also:
    
    SimpleType.minLength, SimpleType.maxLength.
    
    Returns:
    
    `true` if this item has fixed length for `string` and `binary` values.
  - getLocalName
```
public java.lang.String getLocalName()
```
    Return the local name of this type within its owning DataSchema, e.g. "MyType".
    
    Returns:
    
    The local name of this type within its owning DataSchema, e.g. "MyType".
  - getMaxLength
```
public int getMaxLength()
```
    Return maximum length for string and binary values.
    
    See Also:
    
    TypeFacets.ANY_LENGTH.
    
    Returns:
    
    Maximum length for `string` and `binary` values.
  - getMinLength
```
public int getMinLength()
```
    Return minimum length for string and binary values.
    
    See Also:
    
    TypeFacets.ANY_LENGTH.
    
    Returns:
    
    Minimum length for `string` and `binary` values.
  - getName
```
public java.lang.String getName()
```
    Return synonym for SimpleType.qualifiedName.
    
    Overrides:
    
    getName in class DataType
    
    Returns:
    
    Synonym for SimpleType.qualifiedName.
  - getPrecision
```
public int getPrecision()
```
    Return precision for decimal and integer values.
    
    See Also:
    
    TypeFacets.ANY_PRECISION.
    
    Returns:
    
    Precision for `decimal` and `integer` values.
  - getQualifiedName
```
public java.lang.String getQualifiedName()
```
    Return the name of this type qualified by its owning DataSchema name, e.g. "MySchema.MyType".
    
    Returns:
    
    The name of this type qualified by its owning DataSchema name, e.g. "MySchema.MyType".
  - getScale
```
public int getScale()
```
    Return scale for decimal values.
    
    See Also:
    
    TypeFacets.FLOATING_SCALE, TypeFacets.VARIABLE_SCALE.
    
    Returns:
    
    Scale for `decimal` values.
  - getSourceLine
```
public int getSourceLine()
```
    Return source line number for this schema element within its defining schema.
    
    Returns:
    
    Source line number for this schema element within its defining schema.
  - getSrid
```
public int getSrid()
```
    Return EPSG Spatial Reference System Identifier (SRID) for the associated value.
    
    See Also:
    
    TypeFacets.VARIABLE_SRID.
    
    Returns:
    
    [EPSG](http://www.epsg.org/Geodetic.html) Spatial Reference System Identifier (SRID) for the associated value.
  - getTypeFacets
```
public TypeFacets getTypeFacets()
```
    Return (nullable) Type facets for this type. Can be null if there are no custom facets.
    
    Returns:
    
    (nullable) Type facets for this type. Can be null if there are no custom facets.
  - isDerived
```
public boolean isDerived()
```
    Return true if this type is a derived simple, complex, entity or enum type.
    
    Overrides:
    
    isDerived in class DataType
    
    Returns:
    
    true if this type is a derived simple, complex, entity or enum type.
  - isExtension
```
public boolean isExtension()
```
    Return true if this type was added since metadata was originally loaded.
    
    Returns:
    
    true if this type was added since metadata was originally loaded.
  - isInferred
```
public boolean isInferred()
```
    Return true if this simple type was inferred due to a missing term definition in the CSDL.
    
    Returns:
    
    true if this simple type was inferred due to a missing term definition in the CSDL.
  - isRemoved
```
public boolean isRemoved()
```
    Return has this model element been removed by a successful call to DataService.refreshMetadata? If `isRemoved == true, that implies that the old metadata (before refreshMetadata was called) did include this model element, and that the new metadata (after refreshMetadata was called) does not include this model element.
    
    See Also:
    
    SimpleType.canBeRemoved.
    
    Returns:
    
    Has this model element been removed by a successful call to `DataService.refreshMetadata`?
  - isUnicode
```
public boolean isUnicode()
```
    Return true if this item allows Unicode content. If isUnicode is false, then this item only allows ASCII content.
    
    Returns:
    
    true if this item allows Unicode content.
  - setCanBeRemoved
```
public void setCanBeRemoved(boolean value)
```
    Set can this model element be removed by DataService.refreshMetadata. Defaults to false. Set this to true to indicate that the application is coded to be able able to function correctly without this model element.
    
    See Also:
    
    SimpleType.isRemoved.
    
    Parameters:
    
    value - Can this model element be removed by `DataService.refreshMetadata`. Defaults to `false`.
  - setDerivedFrom
```
public void setDerivedFrom(DataType value)
```
    Set synonym for SimpleType.baseType.
    
    Parameters:
    
    value - Synonym for SimpleType.baseType.
  - setExtension
```
public void setExtension(boolean value)
```
    Set true if this type was added since metadata was originally loaded.
    
    Parameters:
    
    value - true if this type was added since metadata was originally loaded.
  - setInferred
```
public void setInferred(boolean value)
```
    Set true if this simple type was inferred due to a missing term definition in the CSDL.
    
    Parameters:
    
    value - true if this simple type was inferred due to a missing term definition in the CSDL.
  - setLocalName
```
public void setLocalName(java.lang.String value)
```
    Set the local name of this type within its owning DataSchema, e.g. "MyType".
    
    Parameters:
    
    value - The local name of this type within its owning DataSchema, e.g. "MyType".
  - setMaxLength
```
public void setMaxLength(int value)
```
    Set maximum length for string and binary values.
    
    See Also:
    
    TypeFacets.ANY_LENGTH.
    
    Parameters:
    
    value - Maximum length for `string` and `binary` values.
  - setMinLength
```
public void setMinLength(int value)
```
    Set minimum length for string and binary values.
    
    See Also:
    
    TypeFacets.ANY_LENGTH.
    
    Parameters:
    
    value - Minimum length for `string` and `binary` values.
  - setPrecision
```
public void setPrecision(int value)
```
    Set precision for decimal and integer values.
    
    See Also:
    
    TypeFacets.ANY_PRECISION.
    
    Parameters:
    
    value - Precision for `decimal` and `integer` values.
  - setQualifiedName
```
public void setQualifiedName(java.lang.String value)
```
    Set the name of this type qualified by its owning DataSchema name, e.g. "MySchema.MyType".
    
    Parameters:
    
    value - The name of this type qualified by its owning DataSchema name, e.g. "MySchema.MyType".
  - setRemoved
```
public void setRemoved(boolean value)
```
    Set has this model element been removed by a successful call to DataService.refreshMetadata? If `isRemoved == true, that implies that the old metadata (before refreshMetadata was called) did include this model element, and that the new metadata (after refreshMetadata was called) does not include this model element.
    
    See Also:
    
    SimpleType.canBeRemoved.
    
    Parameters:
    
    value - Has this model element been removed by a successful call to `DataService.refreshMetadata`?
  - setScale
```
public void setScale(int value)
```
    Set scale for decimal values.
    
    See Also:
    
    TypeFacets.FLOATING_SCALE, TypeFacets.VARIABLE_SCALE.
    
    Parameters:
    
    value - Scale for `decimal` values.
  - setSourceLine
```
public void setSourceLine(int value)
```
    Set source line number for this schema element within its defining schema.
    
    Parameters:
    
    value - Source line number for this schema element within its defining schema.
  - setSrid
```
public void setSrid(int value)
```
    Set EPSG Spatial Reference System Identifier (SRID) for the associated value.
    
    See Also:
    
    TypeFacets.VARIABLE_SRID.
    
    Parameters:
    
    value - [EPSG](http://www.epsg.org/Geodetic.html) Spatial Reference System Identifier (SRID) for the associated value.
  - setTypeFacets
```
public void setTypeFacets(TypeFacets value)
```
    Set type facets for this type. Can be null if there are no custom facets.
    
    Parameters:
    
    value - Type facets for this type. Can be null if there are no custom facets.
  - setUnicode
```
public void setUnicode(boolean value)
```
    Set true if this item allows Unicode content. If isUnicode is false, then this item only allows ASCII content.
    
    Parameters:
    
    value - true if this item allows Unicode content.
  - toString
```
public java.lang.String toString()
```
    Return the name of this data type.
    
    Overrides:
    
    toString in class DataType
    
    Returns:
    
    The name of this data type.

Class SimpleType

Field Summary

Fields inherited from class com.sap.cloud.server.odata.DataType

Constructor Summary

Method Summary

Methods inherited from class com.sap.cloud.server.odata.DataType

Methods inherited from class java.lang.Object

Field Detail

simplr

Constructor Detail

SimpleType

Method Detail

getAnnotation

getAnnotations

getCanBeRemoved

getCode

getDerivedFrom

getFixedLength

getLocalName

getMaxLength

getMinLength

getName

getPrecision

getQualifiedName

getScale

getSourceLine

getSrid

getTypeFacets

isDerived

isExtension

isInferred

isRemoved

isUnicode

setCanBeRemoved

setDerivedFrom

setExtension

setInferred

setLocalName

setMaxLength

setMinLength

setPrecision

setQualifiedName

setRemoved

setScale

setSourceLine

setSrid

setTypeFacets

setUnicode

toString