Return this property object without copying ({@link com.sap.cloud.mobile.kotlin.odata.DataValue#copyMutable() DataValue.copyMutable} does not need to copy metadata objects).

dotString

open fun dotString(): String

Return the name of this property, with dot-separated path segments if {@link com.sap.cloud.mobile.kotlin.odata.Property#hasKeyPath Property.hasKeyPath} is true.

getAnnotation

open fun getAnnotation(term: String): Annotation

Lookup an existing annotation by term name, or throw an exception if the annotation is not found.

See Also:: {@link com.sap.cloud.mobile.kotlin.odata.Property#annotations Property.annotations} and {@link com.sap.cloud.mobile.kotlin.odata.AnnotationMap#get(kotlin.String) AnnotationMap.get}, for looking up annotations that might not exist.

getBasicList

open fun getBasicList(source: StructureBase): DataValueList

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getBinary

open fun getBinary(source: StructureBase): ByteArray

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getBoolean

open fun getBoolean(source: StructureBase): Boolean

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getByte

open fun getByte(source: StructureBase): Byte

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getComplex

open fun getComplex(source: StructureBase): ComplexValue

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getComplexList

open fun getComplexList(source: StructureBase): ComplexValueList

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getDecimal

open fun getDecimal(source: StructureBase): BigDecimal

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getDouble

open fun getDouble(source: StructureBase): Double

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getEntity

open fun getEntity(source: StructureBase): EntityValue

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getEntityList

open fun getEntityList(source: StructureBase): EntityValueList

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getEnum

open fun getEnum(source: StructureBase): EnumValue

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getFloat

open fun getFloat(source: StructureBase): Float

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getGuid

open fun getGuid(source: StructureBase): GuidValue

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getInt

open fun getInt(source: StructureBase): Int

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getInteger

open fun getInteger(source: StructureBase): BigInteger

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getLong

open fun getLong(source: StructureBase): Long

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getNullableBinary

open fun getNullableBinary(source: StructureBase): ByteArray?

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getNullableBoolean

open fun getNullableBoolean(source: StructureBase): Boolean?

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getNullableByte

open fun getNullableByte(source: StructureBase): Byte?

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getNullableComplex

open fun getNullableComplex(source: StructureBase): ComplexValue?

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getNullableDecimal

open fun getNullableDecimal(source: StructureBase): BigDecimal?

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getNullableDouble

open fun getNullableDouble(source: StructureBase): Double?

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getNullableEntity

open fun getNullableEntity(source: StructureBase): EntityValue?

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getNullableEnum

open fun getNullableEnum(source: StructureBase): EnumValue?

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getNullableFloat

open fun getNullableFloat(source: StructureBase): Float?

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getNullableGuid

open fun getNullableGuid(source: StructureBase): GuidValue?

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getNullableInt

open fun getNullableInt(source: StructureBase): Int?

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getNullableInteger

open fun getNullableInteger(source: StructureBase): BigInteger?

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getNullableLong

open fun getNullableLong(source: StructureBase): Long?

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getNullableShort

open fun getNullableShort(source: StructureBase): Short?

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getNullableString

open fun getNullableString(source: StructureBase): String?

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getNullableUnsignedByte

open fun getNullableUnsignedByte(source: StructureBase): Int?

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getOptionalValue

open fun getOptionalValue(source: StructureBase): DataValue?

For internal use only.

getRequiredValue

open fun getRequiredValue(source: StructureBase): DataValue

For internal use only.

getShort

open fun getShort(source: StructureBase): Short

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getStreamLink

open fun getStreamLink(source: StructureBase): StreamLink

Get the stream link for this property from a structure.

getString

open fun getString(source: StructureBase): String

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getUnsignedByte

open fun getUnsignedByte(source: StructureBase): Int

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set, {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

getValue

open fun getValue(source: StructureBase): DataValue?

Get the value of this property from a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set.

path

open fun path(child: Property): DataPath

Return a new data path from this property to a child property.

See Also:: {@link com.sap.cloud.mobile.kotlin.odata.DataPath#path(com.sap.cloud.mobile.kotlin.odata.Property) DataPath.path}.

setBasicList

open fun setBasicList(target: StructureBase, value: DataValueList)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setBinary

open fun setBinary(target: StructureBase, value: ByteArray)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setBoolean

open fun setBoolean(target: StructureBase, value: Boolean)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setByte

open fun setByte(target: StructureBase, value: Byte)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setComplex

open fun setComplex(target: StructureBase, value: ComplexValue)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setComplexList

open fun setComplexList(target: StructureBase, value: ComplexValueList)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setDecimal

open fun setDecimal(target: StructureBase, value: BigDecimal)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setDouble

open fun setDouble(target: StructureBase, value: Double)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setEntity

open fun setEntity(target: StructureBase, value: EntityValue)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setEntityList

open fun setEntityList(target: StructureBase, value: EntityValueList)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setEnum

open fun setEnum(target: StructureBase, value: EnumValue)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setFloat

open fun setFloat(target: StructureBase, value: Float)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setGuid

open fun setGuid(target: StructureBase, value: GuidValue)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setInt

open fun setInt(target: StructureBase, value: Int)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setInteger

open fun setInteger(target: StructureBase, value: BigInteger)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setLong

open fun setLong(target: StructureBase, value: Long)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setNullableBinary

open fun setNullableBinary(target: StructureBase, value: ByteArray?)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setNullableBoolean

open fun setNullableBoolean(target: StructureBase, value: Boolean?)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setNullableByte

open fun setNullableByte(target: StructureBase, value: Byte?)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setNullableComplex

open fun setNullableComplex(target: StructureBase, value: ComplexValue?)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setNullableDecimal

open fun setNullableDecimal(target: StructureBase, value: BigDecimal?)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setNullableDouble

open fun setNullableDouble(target: StructureBase, value: Double?)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setNullableEntity

open fun setNullableEntity(target: StructureBase, value: EntityValue?)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setNullableEnum

open fun setNullableEnum(target: StructureBase, value: EnumValue?)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setNullableFloat

open fun setNullableFloat(target: StructureBase, value: Float?)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setNullableGuid

open fun setNullableGuid(target: StructureBase, value: GuidValue?)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setNullableInt

open fun setNullableInt(target: StructureBase, value: Int?)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setNullableInteger

open fun setNullableInteger(target: StructureBase, value: BigInteger?)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setNullableLong

open fun setNullableLong(target: StructureBase, value: Long?)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setNullableShort

open fun setNullableShort(target: StructureBase, value: Short?)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setNullableString

open fun setNullableString(target: StructureBase, value: String?)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setNullableUnsignedByte

open fun setNullableUnsignedByte(target: StructureBase, value: Int?)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setShort

open fun setShort(target: StructureBase, value: Short)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setString

open fun setString(target: StructureBase, value: String)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setUnsignedByte

open fun setUnsignedByte(target: StructureBase, value: Int)

Set the value of this property in a structure.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the value does not have the expected type for this property.

setValue

open fun setValue(target: StructureBase, value: DataValue?)

Set the value of this property in a structure.

toPath

open override fun toPath(): DataPath

Return this property or path, expressed as a DataPath.

toString

open override fun toString(): String

Convert this data value to a string. If the {@link com.sap.cloud.mobile.kotlin.odata.Property#dataType Property.dataType} is defined by XML Schema Part 2: Datatypes, then the corresponding lexical format is used. JSON format is used for structured values (arrays and objects).

unwrap

open override fun unwrap(): DataValue

Return the path, property, constant value or query function/operator call which is wrapped by this object.

urlString

open fun urlString(): String

Return the name of this property, percent-encoded for use in a URL.

withKey

open fun withKey(entityKey: EntityKey): DataPath

Return a new data path from this property to an item with the specified key.

See Also:: {@link com.sap.cloud.mobile.kotlin.odata.DataPath#withKey(com.sap.cloud.mobile.kotlin.odata.EntityKey) DataPath.withKey}.