See Also:: {@link com.sap.cloud.mobile.kotlin.odata.ComplexValue#copyComplex() ComplexValue.copyComplex}, {@link com.sap.cloud.mobile.kotlin.odata.EntityValue#copyEntity() EntityValue.copyEntity}.

getDataValue

fun getDataValue(path: PropertyPath): DataValue?

Get the value of a specified property path.

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

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

getDynamic

fun getDynamic(name: String): DataValue?

Return (nullable) The value of a dynamic property, or null if no such property exists.

See Also:: {@link com.sap.cloud.mobile.kotlin.odata.StructureBase#dynamicProperties StructureBase.dynamicProperties}.

getNextLink

fun getNextLink(path: PropertyPath): String?

Get the next-link of a specified collection-typed property path.

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

getOptionalValue

fun getOptionalValue(path: PropertyPath): DataValue?

Get the optional value of a specified property path.

getRequiredValue

fun getRequiredValue(path: PropertyPath): DataValue

Get the required value of a specified property path.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UndefinedException} if the property value was not previously set (or is null), {@link com.sap.cloud.mobile.kotlin.odata.core.CastException} if the property value is null.

getSearchWords

open fun getSearchWords(): StringList

open fun getSearchWords(select: PropertyList?): StringList

See getSearchWords(PropertyList?, Boolean).

open fun getSearchWords(select: PropertyList?, tabs: Boolean): StringList

Return the candidate search words in this structure, for use by {@link com.sap.cloud.mobile.kotlin.odata.SearchExpression#matches(com.sap.cloud.mobile.kotlin.odata.StringList) SearchExpression.matches}. Search words are obtained from string-typed properties using {@link com.sap.cloud.mobile.kotlin.odata.SearchExpression#wordsInText(kotlin.String) SearchExpression.wordsInText}.

getStreamLink

fun getStreamLink(property: Property): StreamLink

Get the stream link for a specified stream property.

Throws:: {@link com.sap.cloud.mobile.kotlin.odata.core.UsageException} if the property is not a stream property.

hasChangedProperties

open fun hasChangedProperties(): Boolean

Return true if this structure has one or more changed properties. Seee {@link com.sap.cloud.mobile.kotlin.odata.ComplexValue#oldComplex ComplexValue.oldComplex}, {@link com.sap.cloud.mobile.kotlin.odata.EntityValue#oldEntity EntityValue.oldEntity}.

hasDataType

fun hasDataType(type: DataType): Boolean

Return true if this structure has the specified data type (or a subtype).

hasDataValue

fun hasDataValue(property: Property): Boolean

Return true if this structure contains an explicitly set value for the specified property (including null, if {@link com.sap.cloud.mobile.kotlin.odata.Property#isNullable Property.isNullable}).

hasNextLink

fun hasNextLink(property: Property): Boolean

Return true if this structure contains a next-link for the specified collection-typed property.

isNewOrChanged

open fun isNewOrChanged(property: Property): Boolean

Return true if the value of property property is new or changed.

resolveChildPaths

open fun resolveChildPaths()

Resolve {@link com.sap.cloud.mobile.kotlin.odata.StructureBase#dataPath StructureBase.dataPath} for this structure's child structures.

resolveDataPath

open fun resolveDataPath()

Resolve {@link com.sap.cloud.mobile.kotlin.odata.StructureBase#dataPath StructureBase.dataPath} for this structure. It might still be null afterwards if it cannot be resolved.

resolveDataPaths

open fun resolveDataPaths()

Resolve {@link com.sap.cloud.mobile.kotlin.odata.StructureBase#dataPath StructureBase.dataPath} for this structure and its child structures.

setDataValue

fun setDataValue(property: Property, value: DataValue?)

Set the value of a specified property.

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

setDefaultValues

fun setDefaultValues()

fun setDefaultValues(nestedComplex: Boolean)

fun setDefaultValues(nestedComplex: Boolean, nestedEntity: Boolean)

fun setDefaultValues(nestedComplex: Boolean, nestedEntity: Boolean, defaultOptional: Boolean)

fun setDefaultValues(nestedComplex: Boolean, nestedEntity: Boolean, defaultOptional: Boolean, defaultRequired: Boolean)

See setDefaultValues(Boolean, Boolean, Boolean, Boolean, Boolean).

fun setDefaultValues(nestedComplex: Boolean, nestedEntity: Boolean, defaultOptional: Boolean, defaultRequired: Boolean, skipConstraints: Boolean)

Recursively apply default values to any unset properties of this structure. If a property has a model-defined default value, it will always be applied (since that default value is part of a server's contract with the client, it must always be valid to apply it). If the property doesn't have a model-defined default value, then null will be used for nullable properties, and false/empty/zero values will be applied otherwise as appropriate. Dates will default to 2000-01-01.

See Also:: {@link com.sap.cloud.mobile.kotlin.odata.StructureBase#hasDataValue(com.sap.cloud.mobile.kotlin.odata.Property) StructureBase.hasDataValue}, {@link com.sap.cloud.mobile.kotlin.odata.Property#defaultValue Property.defaultValue}, {@link com.sap.cloud.mobile.kotlin.odata.StructureType#structuralProperties StructureType.structuralProperties}, {@link com.sap.cloud.mobile.kotlin.odata.StructureType#navigationProperties StructureType.navigationProperties}.

setDynamic

fun setDynamic(name: String, value: DataValue?)

Add or change the value of a dynamic property.

See Also:: {@link com.sap.cloud.mobile.kotlin.odata.StructureBase#dynamicProperties StructureBase.dynamicProperties}.

setOptionalValue

fun setOptionalValue(property: Property, value: DataValue?)

Set the optional value of a specified property. If a null value is provided and the property does not permit null values ({@link com.sap.cloud.mobile.kotlin.odata.Property#isNullable Property.isNullable} is false), then this is equivalent to calling unsetDataValue, otherwise it is equivalent to calling setDataValue.

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

setRequiredValue

fun setRequiredValue(property: Property, value: DataValue)

Set the required value of a specified property.

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

setUnsafeValue

fun setUnsafeValue(property: Property, value: DataValue?)

Set the value of a specified property (like {@link com.sap.cloud.mobile.kotlin.odata.StructureBase#setDataValue(com.sap.cloud.mobile.kotlin.odata.Property, com.sap.cloud.mobile.kotlin.odata.DataValue?) StructureBase.setDataValue}), but bypassing the usual validation checks. This may be useful in performance critical code, but note that it will be assumed that:

The property belongs to the structure's type.
The value has the correct type for the property.

unsetDataValue

fun unsetDataValue(property: Property)

Unset the value of a specified property, so that {@link com.sap.cloud.mobile.kotlin.odata.StructureBase#hasDataValue(com.sap.cloud.mobile.kotlin.odata.Property) StructureBase.hasDataValue}(property) will return false.

unsetNavigationProperties

fun unsetNavigationProperties()

Call {@link com.sap.cloud.mobile.kotlin.odata.StructureBase#unsetDataValue(com.sap.cloud.mobile.kotlin.odata.Property) StructureBase.unsetDataValue} for all navigation properties in this structure.

withLock

fun withLock(work: () -> Unit)

Perform some work while holding an instance-level exclusive lock (if this structure is lock-enabled), or without a lock if this structure is not lock-enabled.