SelectItem

open class SelectItem : ObjectBase

Encapsulates an OData select item. A select item indicates a property (or expression) that is used in the $select system query option.

See also

DataQuery.selectItems, DataQuery.select.

  • Obsolete. Use of with unlabeled parameter.

    Declaration

    Swift

    public static func of(property: Property) -> SelectItem

  • Was this select item added for internal use (e.g. needed for server-side query processing, but not requested by client).

    Declaration

    Swift

    final public var isHidden: Bool

  • Default initializer.

    Declaration

    Swift

    override public init()

  • Declaration

    Swift

    open func copyMutable() -> SelectItem

    Return Value

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

  • Declaration

    Swift

    open class func of(_ item: PropertyPath) -> SelectItem

    Parameters

    item

    Item to be selected.

    Return Value

    A new select item for the specified property.

  • A path to be expanded in the query results.

    Declaration

    Swift

    public final var path: DataPath { get set }

  • If this select item references a simple property path, then return the property. Otherwise return nil.

    Declaration

    Swift

    open func toProperty() -> Property?

    Return Value

    The property to be selected, or nil.

  • If this select item references a simple property path, then return the property. Otherwise throw an exception.

    Throws

    UndefinedException if this select item does not reference a simple property path.

    Declaration

    Swift

    open func toRequiredProperty() throws -> Property

    Return Value

    The property to be selected.

  • Declaration

    Swift

    override open func toString() -> String

    Return Value

    A string representation of this select item.