/// <reference path="../uiConfig.ts" />
/// <reference path="constants.ts" />

/**
 * @module UI
 * @submodule UI Survey
 * @namespace ui.survey
 */
namespace internal.ui.survey {

    /**
     * Configuration for a survey question
     * @class SurveyQuestionConfig
     */
    export interface SurveyQuestionConfig {
        /**
         * Question Id from the survey questions
         * @property {number} questionId
         */
        questionId: number;

        /**
         * Optional precanned Response from the list provided with the survey question.
         * @property {string} precannedResponse
         */
        precannedResponse?: string;

        /**
         * Optional verbatim Response
         * @property {string} verbatim
         */
        verbatim?: string;

        /**
         * Question Display Index (that is the display order of the questions)
         * @property {number} questionDisplayIndex
         */
        questionDisplayIndex: number;

        /**
         * Question Category from the survey question
         * @property {string} questionCategory
         */
        questionCategory: string;

    }

    /**
     * Configuration for survey a response
     * @class SurveyResponseConfig
     */
    export interface SurveyResponseConfig {
        /**
         * Flight ID returned by the survey platform.
         * @property {string} flightId
         */
        flightId: string;

        /**
         * Mode of the survey from the flight object
         * @property {string} mode
         */
        mode: string;

        /**
         * Quality of the survey. Set to good if the quality is good, otherwise set to bad for test data.
         * @property {string} quality
         */
        quality: string;

        /**
         * Type of survey
         * @property {string} type
         */
        type: string;

        /**
         * Set to true if this is a partial response. Set to false if the user submitted the survey.
         * @property {boolean} isPartialResponse
         */
        isPartialResponse: boolean;

        /**
         * Display Time of the survey
         * @property {string} displayTime
         */
        displayTime: string;

        /**
         * Survey Responses
         * @property {ui.survey.SurveyQuestionConfig[]} surveyResponse
         */
        surveyResponse: SurveyQuestionConfig[];
    }
}