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

java.lang.Object
- com.sap.cloud.server.odata.AnnotationTerm

```
public class AnnotationTerm
extends java.lang.Object
```
Encapsulates an OData term definition.

See Also:

Annotation.

Constructor Summary

Constructors
Constructor and Description

AnnotationTerm()

Constructors
Constructor and Description
`AnnotationTerm()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`equal(AnnotationTerm a, AnnotationTerm b)` Return `true` if two annotation terms have equal key-values.
`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.
`StringList`	`getAppliesTo()` Return the types of CSDL definition this term applies to.
`AnnotationTerm`	`getBaseTerm()` Return (nullable) Base term if this term is inherited, otherwise `null`.
`DataValue`	`getDefaultValue()` Return (nullable) Default value for `Annotation.value` of annotations referencing this term, or `null` if there is no default value.
`boolean`	`getFixedLength()` Return `true` if this item has fixed length for `string` and `binary` values.
`java.lang.String`	`getLocalName()` Return term name within its defining schema, 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 `AnnotationTerm.qualifiedName`.
`int`	`getPrecision()` Return precision for `decimal` and `integer` values.
`java.lang.String`	`getQualifiedName()` Return term name qualified by its owning schema, 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.
`DataType`	`getType()` Return data type for `Annotation.value` of annotations referencing this term.
`java.lang.String`	`getXmlAttribute()` Return (nullable) If this annotation was derived from an XML attribute, then the attribute name.
`boolean`	`isInferred()` Return `true` if this annotation term was inferred due to a missing term definition in the CSDL.
`boolean`	`isNullable()` Return `true` if this item is nullable.
`boolean`	`isUnicode()` Return `true` if this item allows Unicode content.
`void`	`setAppliesTo(StringList value)` Set the types of CSDL definition this term applies to.
`void`	`setBaseTerm(AnnotationTerm value)` Set base term if this term is inherited, otherwise `null`.
`void`	`setDefaultValue(DataValue value)` Set default value for `Annotation.value` of annotations referencing this term, or `null` if there is no default value.
`void`	`setInferred(boolean value)` Set `true` if this annotation term was inferred due to a missing term definition in the CSDL.
`void`	`setLocalName(java.lang.String value)` Set term name within its defining schema, 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`	`setNullable(boolean value)` Set `true` if this item is nullable.
`void`	`setPrecision(int value)` Set precision for `decimal` and `integer` values.
`void`	`setQualifiedName(java.lang.String value)` Set term name qualified by its owning schema, e.g.
`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`	`setType(DataType value)` Set data type for `Annotation.value` of annotations referencing this term.
`void`	`setUnicode(boolean value)` Set `true` if this item allows Unicode content.
`void`	`setXmlAttribute(java.lang.String value)` Set if this annotation was derived from an XML attribute, then the attribute name.
`java.lang.String`	`toString()`

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

- Constructor Detail
  - AnnotationTerm
```
public AnnotationTerm()
```
- Method Detail
  - equal
```
public static boolean equal(AnnotationTerm a,
                            AnnotationTerm b)
```
    Return true if two annotation terms have equal key-values.
    
    Parameters:
    
    a - (nullable) First annotation term.
    
    b - (nullable) Second annotation term.
    
    Returns:
    
    true if two annotation terms have equal key-values.
  - 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:
    
    AnnotationTerm.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.
  - getAppliesTo
```
public StringList getAppliesTo()
```
    Return the types of CSDL definition this term applies to.
    
    Returns:
    
    The types of CSDL definition this term applies to.
  - getBaseTerm
```
public AnnotationTerm getBaseTerm()
```
    Return (nullable) Base term if this term is inherited, otherwise null.
    
    Returns:
    
    (nullable) Base term if this term is inherited, otherwise null.
  - getDefaultValue
```
public DataValue getDefaultValue()
```
    Return (nullable) Default value for Annotation.value of annotations referencing this term, or null if there is no default value.
    
    Returns:
    
    (nullable) Default value for Annotation.value of annotations referencing this term, or null if there is no default value.
  - getFixedLength
```
public boolean getFixedLength()
```
    Return true if this item has fixed length for string and binary values.
    
    See Also:
    
    AnnotationTerm.minLength, AnnotationTerm.maxLength.
    
    Returns:
    
    `true` if this item has fixed length for `string` and `binary` values.
  - getLocalName
```
public java.lang.String getLocalName()
```
    Return term name within its defining schema, e.g. "MyTerm".
    
    Returns:
    
    Term name within its defining schema, e.g. "MyTerm".
  - 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 AnnotationTerm.qualifiedName.
    
    Returns:
    
    Synonym for AnnotationTerm.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 term name qualified by its owning schema, e.g. "MySchema.MyTerm".
    
    Returns:
    
    Term name qualified by its owning schema, e.g. "MySchema.MyTerm".
  - 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.
  - getType
```
public DataType getType()
```
    Return data type for Annotation.value of annotations referencing this term.
    
    Returns:
    
    Data type for Annotation.value of annotations referencing this term.
  - getXmlAttribute
```
public java.lang.String getXmlAttribute()
```
    Return (nullable) If this annotation was derived from an XML attribute, then the attribute name. XML attribute-based annotations are commonly used in OData 2.0 schemas.
    
    Returns:
    
    (nullable) If this annotation was derived from an XML attribute, then the attribute name.
  - isInferred
```
public boolean isInferred()
```
    Return true if this annotation term was inferred due to a missing term definition in the CSDL.
    
    Returns:
    
    true if this annotation term was inferred due to a missing term definition in the CSDL.
  - isNullable
```
public boolean isNullable()
```
    Return true if this item is nullable.
    
    Returns:
    
    true if this item is nullable.
  - 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.
  - setAppliesTo
```
public void setAppliesTo(StringList value)
```
    Set the types of CSDL definition this term applies to.
    
    Parameters:
    
    value - The types of CSDL definition this term applies to.
  - setBaseTerm
```
public void setBaseTerm(AnnotationTerm value)
```
    Set base term if this term is inherited, otherwise null.
    
    Parameters:
    
    value - Base term if this term is inherited, otherwise null.
  - setDefaultValue
```
public void setDefaultValue(DataValue value)
```
    Set default value for Annotation.value of annotations referencing this term, or null if there is no default value.
    
    Parameters:
    
    value - Default value for Annotation.value of annotations referencing this term, or null if there is no default value.
  - setInferred
```
public void setInferred(boolean value)
```
    Set true if this annotation term was inferred due to a missing term definition in the CSDL.
    
    Parameters:
    
    value - true if this annotation term was inferred due to a missing term definition in the CSDL.
  - setLocalName
```
public void setLocalName(java.lang.String value)
```
    Set term name within its defining schema, e.g. "MyTerm".
    
    Parameters:
    
    value - Term name within its defining schema, e.g. "MyTerm".
  - 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.
  - setNullable
```
public void setNullable(boolean value)
```
    Set true if this item is nullable.
    
    Parameters:
    
    value - true if this item is nullable.
  - 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 term name qualified by its owning schema, e.g. "MySchema.MyTerm".
    
    Parameters:
    
    value - Term name qualified by its owning schema, e.g. "MySchema.MyTerm".
  - 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.
  - setType
```
public void setType(DataType value)
```
    Set data type for Annotation.value of annotations referencing this term.
    
    Parameters:
    
    value - Data type for Annotation.value of annotations referencing this term.
  - 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.
  - setXmlAttribute
```
public void setXmlAttribute(java.lang.String value)
```
    Set if this annotation was derived from an XML attribute, then the attribute name. XML attribute-based annotations are commonly used in OData 2.0 schemas.
    
    Parameters:
    
    value - If this annotation was derived from an XML attribute, then the attribute name.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class AnnotationTerm

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AnnotationTerm

Method Detail

equal

getAnnotation

getAnnotations

getAppliesTo

getBaseTerm

getDefaultValue

getFixedLength

getLocalName

getMaxLength

getMinLength

getName

getPrecision

getQualifiedName

getScale

getSourceLine

getSrid

getType

getXmlAttribute

isInferred

isNullable

isUnicode

setAppliesTo

setBaseTerm

setDefaultValue

setInferred

setLocalName

setMaxLength

setMinLength

setNullable

setPrecision

setQualifiedName

setScale

setSourceLine

setSrid

setType

setUnicode

setXmlAttribute

toString