/**
* @module API
* @submodule API Search
* @namespace api.search
*/

namespace internal.api.search {
    /**
     * Search api request order by expression
     * @class SearchOrderByExpression
     */
    export class SearchOrderByExpression {
        /**
         * The input field name
         * @property {InputFieldNames} name
         */
        public name: OrderByFieldNames;

        /**
         * The order by direction
         * @property {OrderByDirection} direction
         */
        public direction?: OrderByDirection;

        public constructor(
            name: OrderByFieldNames,
            direction?: OrderByDirection) {
            this.name = name;
            this.direction = direction;
        }
    }

    /**
     * Available search api fields for order by on requests enum
     * @class OrderByFieldNames
     * @static
     */
    export enum OrderByFieldNames {
        /**
         * Order by the document score
         * @property {string} SearchScore
         */
        SearchScore = <any>"SearchScore",

        /**
         * Order by the document date
         * @property {string} DocumentDate
         */
        DocumentDate = <any>"DocumentDate",
    }

    /**
     * Search api order by field direction enum
     * @class OrderByDirection
     * @static
     */
    export enum OrderByDirection {
        /**
         * Ascending order
         * @property {string} Ascending
         */
        Ascending = <any>"Ascending",

        /**
         * Descending order
         * @property {string} Descending
         */
        Descending = <any>"Descending",
    }
}