Parameter

open class Parameter : ObjectBase

Encapsulates an OData parameter.

See also

DataMethod, DataMethodCall.

  • Constant parameter mode for ‘In’ mode parameters.

    Declaration

    Swift

    public static let modeIn: Int

  • Constant parameter mode for ‘Out’ mode parameters.

    Declaration

    Swift

    public static let modeOut: Int

  • Constant parameter mode for ‘InOut’ mode parameters.

    Declaration

    Swift

    public static let modeInOut: Int

  • Name of the parameter.

    Declaration

    Swift

    final public var name: String

  • Mode of the parameter.

    See also

    constants.

    Declaration

    Swift

    final public var mode: Int

  • Value of the parameter.

    See also

    DataMethod.parameters (formal), DataMethodCall.parameters (actual).

    Declaration

    Swift

    final public var value: DataValue?

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

    Declaration

    Swift

    final public var sourceLine: Int

  • 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

  • true if this item is nullable.

    Declaration

    Swift

    final public var isOptional: 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) throws -> 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 }

  • Declaration

    Swift

    open func copy() throws -> Parameter

    Return Value

    a copy of this parameter which doesn’t share mutable values with this parameter.

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

    See also

    minLength, maxLength.

    Declaration

    Swift

    open var fixedLength: Bool { get }

  • Declaration

    Swift

    override open func toString() -> String

    Return Value

    A string representation of this object.

  • Type of the parameter.

    Declaration

    Swift

    public final var type: DataType { get set }