Search in this section

Child pages
  • Order Element
Skip to end of metadata
Go to start of metadata


Table of contents

Description

The order element is responsible for sorting the search result.

Structure

KeyOccursFormatTypDescription
key0 - 1String

Keyword to be sorted by

mode0 - 1 enum

OrderType
Enum

Sort order (asc/desc)

XML Example

XML Example
<order>
    <key>created</key>
    <mode>asc</mode>
</order>

Code Example

Order Component Java
@XmlRootElement(name = "order")
public class Order {

    @XmlElement(name="key")
    private String key;

    @XmlElement(name="type")
    private OrderType type;

    /* Getter + Setter */

}
Order Component PHP
class Order {

    /**
     *
     * @var type String
     */
    public $key;

    /**
     *
     * @var type OrderType
     */
    public $type;

    /* Getter + Setter */

}
Order Component C#
public class Order {

    private String key;

    private OrderType type;

    /* Getter + Setter */

}