EnumType

open class EnumType: DataType

Encapsulates the metadata of an OData enum type.

  • 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 = false
  • 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 = false
  • Represents an undefined enum type.

    Declaration

    Swift

    public static let undefined: EnumType = EnumType._new1_in_EnumType("undefined", EnumValueMap.empty, EnumValueList.empty, false, "undefined", DataType.unknown)
  • The local name of this type within its owning DataSchema, e.g. MyType.

    Declaration

    Swift

    final public var localName: String = ""
  • The name of this type qualified by its owning DataSchema name, e.g. MySchema.MyType.

    Declaration

    Swift

    final public var qualifiedName: String = ""
  • True if this type was added since metadata was originally loaded.

    Declaration

    Swift

    final public var isExtension: Bool = false
  • true if this simple type was inferred due to a missing term definition in the CSDL.

    Declaration

    Swift

    final public var isInferred: Bool = false
  • Does this enum type represent a set of bit flags?

    Declaration

    Swift

    final public var isFlags: Bool = false
  • List of members for this type.

    Declaration

    Swift

    final public var memberList: EnumValueList!
  • Map of members for this type.

    Declaration

    Swift

    final public var memberMap: EnumValueMap!
  • Default initializer.

    Declaration

    Swift

    override public init()
  • List of annotations for this type.

    Declaration

    Swift

    open var annotationList: AnnotationList
  • Map of annotations for this type.

    Declaration

    Swift

    open var annotationMap: AnnotationMap
  • DataType.ENUM_VALUE.

    Declaration

    Swift

    override open var code: Int
  • Synonym for baseType.

    Declaration

    Swift

    open var derivedFrom: DataType
  • Lookup a member by name.

    Declaration

    Swift

    open func findMember(name: String) -> EnumValue?

    Parameters

    name

    Name of the member, or numeric value.

    Return Value

    The member value, or nil if not found.

  • true if this type is a derived simple, complex, entity or enum type.

    Declaration

    Swift

    override open var isDerived: Bool
  • Lookup a member by name.

    Throws

    UndefinedException if no member is found with this name.

    Declaration

    Swift

    open func member(name: String) -> EnumValue

    Parameters

    name

    Name of the member, or numeric value.

    Return Value

    The member value.

  • Synonym for qualifiedName.

    Declaration

    Swift

    override open var name: String
  • Declaration

    Swift

    override open func toString() -> String

    Return Value

    The name of this data type.

  • Declaration

    Swift

    open func withByte(_ value: Int) -> EnumValue

    Parameters

    value

    Numeric enum value.

    Return Value

    A value of this enum type with the specified value.

  • Declaration

    Swift

    open func withInt(_ value: Int) -> EnumValue

    Parameters

    value

    Numeric enum value.

    Return Value

    A value of this enum type with the specified value.

  • Declaration

    Swift

    open func withLong(_ value: Int64) -> EnumValue

    Parameters

    value

    Numeric enum value.

    Return Value

    A value of this enum type with the specified value.

  • Declaration

    Swift

    open func withOptionalByte(_ value: Int?) -> EnumValue?

    Parameters

    value

    Numeric enum value.

    Return Value

    A value of this enum type with the specified value.

  • Declaration

    Swift

    open func withOptionalInt(_ value: Int?) -> EnumValue?

    Parameters

    value

    Numeric enum value.

    Return Value

    A value of this enum type with the specified value.

  • Declaration

    Swift

    open func withOptionalLong(_ value: Int64?) -> EnumValue?

    Parameters

    value

    Numeric enum value.

    Return Value

    A value of this enum type with the specified value.

  • Declaration

    Swift

    open func withOptionalShort(_ value: Int?) -> EnumValue?

    Parameters

    value

    Numeric enum value.

    Return Value

    A value of this enum type with the specified value.

  • Declaration

    Swift

    open func withShort(_ value: Int) -> EnumValue

    Parameters

    value

    Numeric enum value.

    Return Value

    A value of this enum type with the specified value.

  • Declaration

    Swift

    open func withUnsignedByte(_ value: UnsignedByte?) -> EnumValue?

    Parameters

    value

    Numeric enum value.

    Return Value

    A value of this enum type with the specified value.