Property

open class Property : PropertyPath

Encapsulates the metadata of an OData structural or navigation property. Used for properties of complex and entity types.

  • Related entities will be deleted if the source entity is deleted.

    See also

    onDeleteAction.

    Declaration

    Swift

    public static let onDeleteCascade: Int

  • A delete request on a source entity with related entities will fail.

    Declaration

    Swift

    public static let onDeleteRestrict: Int

  • All properties of related entities that are tied to properties of the source entity via a referential constraint and that do not participate in other referential constraints will be set to their default value.

    Declaration

    Swift

    public static let onDeleteSetDefault: Int

  • All properties of related entities that are tied to properties of the source entity via a referential constraint and that do not participate in other referential constraints will be set to nil.

    Declaration

    Swift

    public static let onDeleteSetNull: Int

  • There are no foreign keys for this navigation property.

    See also

    hasForeignKeys.

    Declaration

    Swift

    public static let hasNoForeignKeys: Int

  • Foreign keys for this navigation property exist on the source side of the relationship.

    See also

    hasForeignKeys.

    Declaration

    Swift

    public static let hasForeignKeysInSource: Int

  • Foreign keys for this navigation property exist on the target side of the relationship.

    See also

    hasForeignKeys.

    Declaration

    Swift

    public static let hasForeignKeysInTarget: Int

  • 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

    isRemoved.

    Declaration

    Swift

    final public var canBeRemoved: Bool

  • 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

    canBeRemoved.

    Declaration

    Swift

    final public var isRemoved: Bool

  • When this property is persisted, and it has complex type, can it be flattened into separate columns? Defaults to true.

    Declaration

    Swift

    final public var allowsFlattening: Bool

  • A database-level column default for this property.

    Declaration

    Swift

    final public var columnDefault: String?

  • A value for this property can be provided by the client on insert. If no value is provided by the client, a default value is generated by the database.

    Declaration

    Swift

    final public var hasColumnDefault: Bool

  • If isKey is true and isForeignKey is false, then isGeneratedKey defaults to true. Set to false to disable backend key generation for this property.

    Declaration

    Swift

    final public var isGeneratedKey: Bool
  • id

    Zero-based index for this property within its parent type definition.

    Declaration

    Swift

    final public var id: Int

  • True if the property value is text which can be pretty printed in CSDL documents (preserving relative indentation of lines but shifted for context).

    Declaration

    Swift

    final public var prettyText: Bool

  • Name of type that owns this property.

    Declaration

    Swift

    final public var owningType: String

  • Source line number for this schema element within its defining schema.

    Declaration

    Swift

    final public var sourceLine: Int

  • Path for customized property-to-element mapping.

    Declaration

    Swift

    final public var customPath: CustomPath?

  • Database column name for this property.

    Declaration

    Swift

    final public var column: String?

  • Database column type for this property.

    Declaration

    Swift

    final public var columnType: String?

  • true if this property represents a key path, i.e. the property value is obtained by following a path rather than being directly contained in the associated entity instance.

    Declaration

    Swift

    final public var hasKeyPath: Bool

  • true if this property is the primary key, or part of a composite primary key.

    Declaration

    Swift

    final public var isKey: Bool

  • true if this property is a foreign key, or part of a composite foreign key.

    Declaration

    Swift

    final public var isForeignKey: Bool

  • true if this property was added since metadata was originally loaded.

    Declaration

    Swift

    final public var isExtension: Bool

  • true if this property is used for optimistic concurrency control (part of entity tag). For OData V3, this relates to a ConcurrencyMode of “Fixed”. For OData V4, this relates to the use of Org.OData.Core.V1.OptimisticConcurrency in one or more entity sets using the entity type containing this property.

    Declaration

    Swift

    final public var isOptimistic: Bool

  • true if this item allows Unicode content. If isUnicode is false, then this item only allows ASCII content.

    Declaration

    Swift

    final public var isUnicode: Bool

  • Minimum length for string and binary values.

    See also

    TypeFacets.ANY_LENGTH.

    Declaration

    Swift

    final public var minLength: Int

  • Maximum length for string and binary values.

    See also

    TypeFacets.ANY_LENGTH.

    Declaration

    Swift

    final public var maxLength: Int

  • Precision for decimal and integer values.

    See also

    TypeFacets.ANY_PRECISION.

    Declaration

    Swift

    final public var precision: Int

  • Scale for decimal values.

    See also

    TypeFacets.FLOATING_SCALE, TypeFacets.VARIABLE_SCALE.

    Declaration

    Swift

    final public var scale: Int

  • EPSG Spatial Reference System Identifier (SRID) for the associated value.

    See also

    TypeFacets.VARIABLE_SRID.

    Declaration

    Swift

    final public var srid: Int

  • Default value for this item. May be nil.

    Declaration

    Swift

    final public var defaultValue: DataValue?

  • true if this item is nullable.

    Declaration

    Swift

    final public var isOptional: Bool

  • Was this property synthesized, e.g. to hold referentialConstraints for a unidirectional relationship?

    Declaration

    Swift

    final public var isSynthesized: Bool

  • Default initializer.

    Declaration

    Swift

    override public init()

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

    See also

    annotations and AnnotationMap.get, for looking up annotations that might not exist.

    Declaration

    Swift

    open func annotation(withName term: String) -> Annotation

    Parameters

    term

    The term name.

    Return Value

    The annotation.

  • Obsolete. Use annotations.

    Declaration

    Swift

    open var annotationList: AnnotationList { get }

  • Obsolete. Use annotations.

    Declaration

    Swift

    open var annotationMap: AnnotationMap { get }

  • 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.

    Declaration

    Swift

    open var annotations: AnnotationMap { get }

  • See also

    DataPath.atIndex.

    Declaration

    Swift

    open func atIndex(_ itemIndex: Int) -> DataPath

    Parameters

    itemIndex

    Item inedx.

    Return Value

    A new data path from this property to an item at the specified index.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func basicList(from source: StructureBase) -> DataValueList

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func binaryValue(from source: StructureBase) -> Data

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func booleanValue(from source: StructureBase) -> Bool

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func byteValue(from source: StructureBase) -> Int

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func complexList(from source: StructureBase) -> ComplexValueList

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • If this property has a complex type, then return it. Otherwise panic.

    See also

    DataType.isComplex.

    Declaration

    Swift

    open var complexType: ComplexType { get }

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func complexValue(from source: StructureBase) -> ComplexValue

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • If this property is a navigation property, then does it contain its target?

    Declaration

    Swift

    open var containsTarget: Bool { get set }

  • Declaration

    Swift

    override open func copyMutable() -> DataValue

    Return Value

    self property object without copying (DataValue.copyMutable does not need to copy metadata objects).

  • Data type of the property.

    See also

    type for detailed usage information and example code.

    Declaration

    Swift

    override open var dataType: DataType { get }

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set.

    Declaration

    Swift

    open func dataValue(from source: StructureBase) -> DataValue?

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func decimalValue(from source: StructureBase) -> BigDecimal

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Declaration

    Swift

    open func dotString() -> String

    Return Value

    The name of this property, with dot-separated path segments if hasKeyPath is true.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func doubleValue(from source: StructureBase) -> Double

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Percent-encoded name.

    Declaration

    Swift

    open var encodedName: String { get }

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func entityList(from source: StructureBase) -> EntityValueList

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • If this property has an entity type, then return it. Otherwise panic.

    See also

    DataType.isEntity.

    Declaration

    Swift

    open var entityType: EntityType { get }

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func entityValue(from source: StructureBase) -> EntityValue

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • If this property has an enum type, then return it. Otherwise panic.

    See also

    DataType.isEnum.

    Declaration

    Swift

    open var enumType: EnumType { get }

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func enumValue(from source: StructureBase) -> EnumValue

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • true if this item has fixed length for string and binary values.

    See also

    minLength, maxLength.

    Declaration

    Swift

    open var fixedLength: Bool { get }

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func floatValue(from source: StructureBase) -> Float

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func guidValue(from source: StructureBase) -> GuidValue

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • If this property is a navigation property, then where are foreign keys found.

    See also

    constants.

    Declaration

    Swift

    open var hasForeignKeys: Int { get set }

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func intValue(from source: StructureBase) -> Int

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func integerValue(from source: StructureBase) -> BigInteger

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • true if this property has a binary type.

    Declaration

    Swift

    open var isBinary: Bool { get }

  • true if this is a collection-typed property. Equivalent to type.isList.

    Declaration

    Swift

    open var isCollection: Bool { get }

  • true if this is a property with complex type. Equivalent to type.isComplex.

    Declaration

    Swift

    open var isComplex: Bool { get }

  • true if this is a list-typed property with complex item type. Equivalent to type.isComplexList.

    Declaration

    Swift

    open var isComplexList: Bool { get }

  • true if this is a property with entity type. Equivalent to type.isEntity.

    Declaration

    Swift

    open var isEntity: Bool { get }

  • true if this is a list-typed property with entity item type. Equivalent to type.isEntityList.

    Declaration

    Swift

    open var isEntityList: Bool { get }

  • true if this property is immutable (non-updatable after insert).

    Declaration

    Swift

    open var isImmutable: Bool { get set }

  • true if this is a navigation property.

    Declaration

    Swift

    open var isNavigation: Bool { get }

  • true if this property is persistent (stored in the local database when offline).

    Declaration

    Swift

    open var isPersistent: Bool { get }

  • true if this property has a stream type.

    Declaration

    Swift

    open var isStream: Bool { get }

  • true if this is a structural property.

    Declaration

    Swift

    open var isStructural: Bool { get }

  • true if this is a property with structure type. Equivalent to type.isStructure.

    Declaration

    Swift

    open var isStructure: Bool { get }

  • true if this is a list-typed property with structure item type. Equivalent to type.isStructureList.

    Declaration

    Swift

    open var isStructureList: Bool { get }

  • If this property is a list with complex item type, then return it. Otherwise panic.

    See also

    DataType.isComplexList.

    Declaration

    Swift

    open var itemComplexType: ComplexType { get }

  • If this property is a list with entity item type, then return it. Otherwise panic.

    See also

    DataType.isEntityList.

    Declaration

    Swift

    open var itemEntityType: EntityType { get }

  • If this property is a list with structure item type, then return it. Otherwise panic.

    See also

    DataType.isEntityList.

    Declaration

    Swift

    open var itemStructureType: StructureType { get }

  • If this property has a list type, then return it. Otherwise panic.

    See also

    DataType.isList.

    Declaration

    Swift

    open var itemType: DataType { get }

  • Custom JSON field for request/response payload (e.g. for OpenAPI interoperability), otherwise name.

    Declaration

    Swift

    @inline(__always)
public final var jsonField: String { get set }

  • If hasKeyPath is true, then the key path. Otherwise unused.

    Declaration

    Swift

    public final var keyPath: DataPath { get set }

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func longValue(from source: StructureBase) -> Int64

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Name of the property.

    Declaration

    Swift

    @inline(__always)
public final var name: String { get set }

  • If this property is a navigation property, then the action upon deletion of the source entity. Zero indicates an undefined action.

    See also

    ON_DELETE_* constants.

    Declaration

    Swift

    open var onDeleteAction: Int { get set }

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func optionalBinary(from source: StructureBase) -> Data?

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func optionalBoolean(from source: StructureBase) -> Bool?

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func optionalByte(from source: StructureBase) -> Int?

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func optionalComplex(from source: StructureBase) -> ComplexValue?

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func optionalDecimal(from source: StructureBase) -> BigDecimal?

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func optionalDouble(from source: StructureBase) -> Double?

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func optionalEntity(from source: StructureBase) -> EntityValue?

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func optionalEnum(from source: StructureBase) -> EnumValue?

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func optionalFloat(from source: StructureBase) -> Float?

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func optionalGuid(from source: StructureBase) -> GuidValue?

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func optionalInt(from source: StructureBase) -> Int?

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func optionalInteger(from source: StructureBase) -> BigInteger?

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func optionalLong(from source: StructureBase) -> Int64?

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func optionalShort(from source: StructureBase) -> Int?

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func optionalString(from source: StructureBase) -> String?

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func optionalUnsignedByte(from source: StructureBase) -> Int?

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • If this property is a navigation property with a defined partner property, then the path of the partner.

    Declaration

    Swift

    open var partnerPath: String? { get set }

  • See also

    DataPath.path.

    Declaration

    Swift

    open func path(_ child: Property) -> DataPath

    Parameters

    child

    Child property.

    Return Value

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

  • Owning type name, forward slash, then property name, e.g. “MySchema.MyEntityType/MyPropertyName”.

    Declaration

    Swift

    open var qualifiedName: String { get }

  • If this property is a navigation property with referential constraints, then a map of constraints (from property name in the dependent entity to property name in the principal entity).

    Declaration

    Swift

    open var referentialConstraints: StringMap { get set }

  • Returns entityType or itemEntityType, if one of them is applicable to this property. Otherwise panic.

    See also

    DataType.isEntity, DataType.isEntityList.

    Declaration

    Swift

    open var relatedEntityType: EntityType { get }

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setBasicList(in target: StructureBase, to value: DataValueList)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setBinaryValue(in target: StructureBase, to value: Data)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setBinaryValue(in target: StructureBase, to value: Data?)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setBooleanValue(in target: StructureBase, to value: Bool)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setBooleanValue(in target: StructureBase, to value: Bool?)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setByteValue(in target: StructureBase, to value: Int)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setByteValue(in target: StructureBase, to value: Int?)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setComplexList(in target: StructureBase, to value: ComplexValueList)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setComplexValue(in target: StructureBase, to value: ComplexValue)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setComplexValue(in target: StructureBase, to value: ComplexValue?)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Declaration

    Swift

    open func setDataValue(in target: StructureBase, to value: DataValue?)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setDecimalValue(in target: StructureBase, to value: BigDecimal)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setDecimalValue(in target: StructureBase, to value: BigDecimal?)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setDoubleValue(in target: StructureBase, to value: Double)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setDoubleValue(in target: StructureBase, to value: Double?)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setEntityList(in target: StructureBase, to value: EntityValueList)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setEntityValue(in target: StructureBase, to value: EntityValue)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setEntityValue(in target: StructureBase, to value: EntityValue?)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setEnumValue(in target: StructureBase, to value: EnumValue)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setEnumValue(in target: StructureBase, to value: EnumValue?)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setFloatValue(in target: StructureBase, to value: Float)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setFloatValue(in target: StructureBase, to value: Float?)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setGuidValue(in target: StructureBase, to value: GuidValue)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setGuidValue(in target: StructureBase, to value: GuidValue?)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setIntValue(in target: StructureBase, to value: Int)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setIntValue(in target: StructureBase, to value: Int?)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setIntegerValue(in target: StructureBase, to value: BigInteger)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setIntegerValue(in target: StructureBase, to value: BigInteger?)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setLongValue(in target: StructureBase, to value: Int64)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setLongValue(in target: StructureBase, to value: Int64?)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setShortValue(in target: StructureBase, to value: Int)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setShortValue(in target: StructureBase, to value: Int?)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setStringValue(in target: StructureBase, to value: String)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setStringValue(in target: StructureBase, to value: String?)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setUnsignedByteValue(in target: StructureBase, to value: Int)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Set the value of this property in a structure.

    Throws

    CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func setUnsignedByteValue(in target: StructureBase, to value: Int?)

    Parameters

    target

    Target structure.
    value

    Property value.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func shortValue(from source: StructureBase) -> Int

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Get the stream link for this property from a structure.

    Declaration

    Swift

    open func streamLink(from source: StructureBase) -> StreamLink

    Parameters

    source

    Source structure.

    Return Value

    Stream link.

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func stringValue(from source: StructureBase) -> String

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • If this property has a structure (complex/entity) type, then return it. Otherwise throw UsageException.

    Declaration

    Swift

    open var structureType: StructureType { get }

  • Declaration

    Swift

    override open func toPath() -> DataPath

    Return Value

    this property or path, expressed as a DataPath.

  • Convert this data value to a string. If the 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).

    Declaration

    Swift

    override open func toString() -> String

    Return Value

    Lexical representation of this data value.

  • Synonym for dataType. If this property has a basic type, then type.isBasic will be true. If this property has a basic list type, then type.isBasicList will be true. If this property has a complex type, then type.isComplex will be true and type will be an instance of ComplexType. If this property has a complex list type, then type.isComplexList will be true and type.itemType will be an instance of ComplexType. If this property has an entity type, then type.isEntity will be true and type will be an instance of EntityType. If this property has an entity list type, then type.isEntityList will be true and type.itemType will be an instance of EntityType.

    See also

    DataType.isBasic, DataType.isBasicList, DataType.isComplex, DataType.isComplexList, DataType.isEntity, DataType.isEntityList.

    Declaration

    Swift

    public final var type: DataType { get set }

  • Synonym for dataType.code.

    Declaration

    Swift

    override public final var typeCode: Int { get }

  • Get the value of this property from a structure.

    Throws

    UndefinedException if the property value was not previously set, CastException if the value does not have the expected type for this property.

    Declaration

    Swift

    open func unsignedByteValue(from source: StructureBase) -> Int

    Parameters

    source

    Source structure.

    Return Value

    Property value.

  • Declaration

    Swift

    override open func unwrap() -> DataValue

    Return Value

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

  • Declaration

    Swift

    open func urlString() -> String

    Return Value

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

  • See also

    DataPath.withKey.

    Declaration

    Swift

    open func withKey(_ entityKey: EntityKey) -> DataPath

    Parameters

    entityKey

    Entity key.

    Return Value

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