QueryResult Class Reference


                      
                      
                      init(query:result:status:error:)

Construct a new query result.

Declaration

Swift

public init(query: DataQuery, result: DataValue?, status: Int = (200 as Int), error: DataServiceError? = nil)

Parameters

`query`	Data query.
`result`	Result value.
`status`	Result status (using HTTP status codes).
`error`	Error, if the query failed, otherwise `nil`.


                      
                      
                      basicList()

Throws

QueryResultException if the result does not have the expected type.

Declaration

Swift

open func basicList() throws -> DataValueList

Return Value

The basic list for this result.


                      
                      
                      byteStream()

Throws

QueryResultException if the result does not have the expected type.

Declaration

Swift

open func byteStream() throws -> ByteStream

Return Value

The byte stream for this result.


                      
                      
                      charStream()

Throws

QueryResultException if the result does not have the expected type.

Declaration

Swift

open func charStream() throws -> CharStream

Return Value

The character stream for this result.


                      
                      
                      check(fixOptions:)

Check if the result is valid with respect to the query. A result will be considered invalid if it is missing properties that were expected according to the use of DataQuery.select or DataQuery.expand in the query.

Throws

QueryResultException if the result is definitely not valid.

Declaration

Swift

open func check(fixOptions: Int = (0 as Int)) throws

Parameters


                                  fixOptions

Flags for fixing invalid OData payload


                      
                      
                      checkedResult()

Declaration

Swift

open func checkedResult() throws -> DataValue?

Return Value

The expected result, or throw error if it is non-null.


                      
                      
                      complexList()

Throws

QueryResultException if the result does not have the expected type.

Declaration

Swift

open func complexList() throws -> ComplexValueList

Return Value

The complex list for this result.


                      
                      
                      count()

Throws

QueryResultException if the result does not have the expected type.

See also

DataQuery.count, Requesting the Number of Items in a Collection.

Declaration

Swift

open func count() throws -> Int64

Return Value

The “count” for this result.


                      
                      
                      deltaLink()

Throws

QueryResultException if the result does not have the expected type.

See also

EntityValueList.deltaLink.

Declaration

Swift

open func deltaLink() throws -> String?

Return Value

The “delta link” for this result.


                      
                      
                      deltaStream()

Throws

QueryResultException if the result does not have the expected type.

Declaration

Swift

open func deltaStream() throws -> DeltaStream

Return Value

The delta stream for this result.


                      
                      
                      entityList()

Throws

QueryResultException if the result does not have the expected type.

Example using proxy classes

open func entityListExample() throws -> Void {
    let service = self.service
    let query = DataQuery()
        .select(Customer.customerID, Customer.companyName, Customer.contactName)
        .orderBy(Customer.companyName)
    let customers = try service.fetchCustomers(matching: query)
    for customer in customers {
        self.showCustomer(customer)
    }
}

Example using dynamic API

open func entityListExample() throws -> Void {
    let service = self.service
    let customersEntitySet = service.entitySet(withName: "Customers")
    let customerEntityType = customersEntitySet.entityType
    let customerIDProperty = customerEntityType.property(withName: "CustomerID")
    let companyNameProperty = customerEntityType.property(withName: "CompanyName")
    let contactNameProperty = customerEntityType.property(withName: "ContactName")
    let query = DataQuery()
        .select(customerIDProperty, companyNameProperty, contactNameProperty)
        .from(customersEntitySet).orderBy(companyNameProperty)
    let customers = try service.executeQuery(query).entityList()
    for customer in customers {
        self.showCustomer(customer)
    }
}

Declaration

Swift

open func entityList() throws -> EntityValueList

Return Value

The entity list for this result.


                      
                      
                      entityStream()

Throws

QueryResultException if the result does not have the expected type.

Declaration

Swift

open func entityStream() throws -> EntityStream

Return Value

The entity stream for this result.


                      
                      
                      error

Error if status does not represent a successful response.

Declaration

Swift

open var error: DataServiceError? { get }


                      
                      
                      inlineCount()

Throws

QueryResultException if the result does not have an inline “total count”.

See also

DataQuery.inlineCount, System Query Option $count.

Declaration

Swift

open func inlineCount() throws -> Int64

Return Value

The inline “total count” for this result.


                      
                      
                      nextLink()

Throws

QueryResultException if the result does not have the expected type.

See also

EntityValueList.nextLink.

Declaration

Swift

open func nextLink() throws -> String?

Return Value

The “next link” for this result.


                      
                      
                      nextQuery()

Throws

QueryResultException if the result does not have the expected type.

See also

EntityValueList.nextLink.

Declaration

Swift

open func nextQuery() throws -> DataQuery

Return Value

The “next query” for this result. The query will have a non-nil URL if this result includes a nextLink.


                      
                      
                      optionalBasic()

Throws

QueryResultException if the result does not have the expected type.

Declaration

Swift

open func optionalBasic() throws -> DataValue?

Return Value

The optional basic value of this result.


                      
                      
                      optionalComplex()

Throws

QueryResultException if the result does not have the expected type.

Declaration

Swift

open func optionalComplex() throws -> ComplexValue?

Return Value

The optional complex value of this result.


                      
                      
                      optionalEntity()

Throws

QueryResultException if the result does not have the expected type.

Example using proxy classes

open func optionalEntityExample() throws -> Void {
    let service = self.service
    let query = DataQuery()
        .select(Customer.customerID, Customer.companyName, Customer.contactName)
        .orderBy(Customer.companyName).top(1)
    if let customer = try Single.optional(service.fetchCustomers(matching: query)) {
        self.showCustomer(customer)
    }
}

Example using dynamic API

open func optionalEntityExample() throws -> Void {
    let service = self.service
    let customersEntitySet = service.entitySet(withName: "Customers")
    let customerEntityType = customersEntitySet.entityType
    let customerIDProperty = customerEntityType.property(withName: "CustomerID")
    let companyNameProperty = customerEntityType.property(withName: "CompanyName")
    let contactNameProperty = customerEntityType.property(withName: "ContactName")
    let query = DataQuery()
        .select(customerIDProperty, companyNameProperty, contactNameProperty)
        .from(customersEntitySet).orderBy(companyNameProperty).top(1)
    if let customer = try service.executeQuery(query).optionalEntity() {
        self.showCustomer(customer)
    }
}

Declaration

Swift

open func optionalEntity() throws -> EntityValue?

Return Value

The optional entity value of this result.


                      
                      
                      query

Data query.

Declaration

Swift

open var query: DataQuery { get }


                      
                      
                      requiredBasic()

Throws

QueryResultException if the result does not have the expected type.

Declaration

Swift

open func requiredBasic() throws -> DataValue

Return Value

The required basic value of this result.


                      
                      
                      requiredComplex()

Throws

QueryResultException if the result does not have the expected type.

Declaration

Swift

open func requiredComplex() throws -> ComplexValue

Return Value

The required complex value of this result.


                      
                      
                      requiredEntity()

Throws

QueryResultException if the result does not have the expected type.

Example using proxy classes

open func requiredEntityExample() throws -> Void {
    let service = self.service
    let query = DataQuery()
        .select(Customer.customerID, Customer.companyName, Customer.contactName)
        .orderBy(Customer.companyName).top(1)
    let customer = try service.fetchCustomer(matching: query)
    self.showCustomer(customer)
}

Example using dynamic API

open func requiredEntityExample() throws -> Void {
    let service = self.service
    let customersEntitySet = service.entitySet(withName: "Customers")
    let customerEntityType = customersEntitySet.entityType
    let customerIDProperty = customerEntityType.property(withName: "CustomerID")
    let companyNameProperty = customerEntityType.property(withName: "CompanyName")
    let contactNameProperty = customerEntityType.property(withName: "ContactName")
    let query = DataQuery()
        .select(customerIDProperty, companyNameProperty, contactNameProperty)
        .from(customersEntitySet).orderBy(companyNameProperty).top(1)
    let customer = try service.executeQuery(query).requiredEntity()
    self.showCustomer(customer)
}

Declaration

Swift

open func requiredEntity() throws -> EntityValue

Return Value

The required entity value of this result.


                      
                      
                      resolveDataPaths()

Resolve the StructureBase.dataPath for each structure in the graph of this query result.

Declaration

Swift

open func resolveDataPaths() throws


                      
                      
                      result

Result value. Can be null if error is non-null, even if the query wasn’t expected to return null values.

See also

getCheckedResult, to obtain the expected result, or throw error if the request failed.

Declaration

Swift

open var result: DataValue? { get }


                      
                      
                      status

Result status (e.g. HTTP status code 200 = OK).

Declaration

Swift

open var status: Int { get }


                      
                      
                      withDefaults()

Declaration

Swift

open func withDefaults() throws -> QueryResult

Return Value

This query result, after calling StructureBase.setDefaultValues on all structures within the result.