Types
Index
CitrusBuilder.AbstractQuestion
CitrusBuilder.AbstractSurveyComponent
CitrusBuilder.LanguageSetting
CitrusBuilder.LanguageSettings
CitrusBuilder.Question
CitrusBuilder.QuestionGroup
CitrusBuilder.ResponseOption
CitrusBuilder.ResponseScale
CitrusBuilder.SubQuestion
CitrusBuilder.Survey
Type specification
CitrusBuilder.AbstractQuestion
— TypeAbstractQuestion <: AbstractSurveyComponent
An abstract type representing a question within a LimeSurvey.
CitrusBuilder.AbstractSurveyComponent
— TypeAbstractSurveyComponent
An abstract type that represents a component within a LimeSurvey survey.
CitrusBuilder.LanguageSetting
— TypeLanguageSetting
A type representing the settings of a survey component for a single language.
Fields
language::String
: The definition of the localetitle::title
: The title of the survey component in the languagehelp::Union{Nothing, String}
: The help text of the survey component in the languagedescription::Union{Nothing, String}
: The description of the survey component in the languagedefault::Union{Nothing, String}
: The default value of the survey component in the language
CitrusBuilder.LanguageSettings
— TypeLanguageSettings
A type representing a collection of single LanguageSetting
.
Fields
settings::Vector{LanguageSetting}
: A collection of language settings.same_default::Bool
: An indicator whether or not the same default value is used for all languages.
CitrusBuilder.Question
— TypeQuestion <: AbstractQuestion
A survey component that stores information about LimeSurvey questions.
Fields
id::String
: An alphanumeric question id. Must start with a letter.type::String
: The LimeSurvey question typemandatory::Bool
: Determines if the question is mandatoryother::Bool
: Determines if the questions as other categoryrelevance::String
: A LimeSurvey Expression Scriptattributes::Dict
: Additional question attributeslanguage_settings::LanguageSettings
: Language Settings for the questionsubquestions::Vector{Subquestion}
: A vector of subquestionsoptions::Vector{ResponseScale}
: A vector of response scales.
CitrusBuilder.QuestionGroup
— TypeQuestionGroup <: AbstractSurveyComponent
A type representing a question group within a LimeSurvey
Fields
id::Int
: An integer-valued ID for the question grouplanguage_settings::LanguageSettings
: The language settings for the question groupchildren::Vector{Question}
: A vector of questions as child elements of the question group
CitrusBuilder.ResponseOption
— TypeResponseOption <: AbstractSurveyComponent
A type representing a single response option for a LimeSurvey question.
Fields
id::String
: A LimeSurvey ID for the response optionlanguage_settings::LanguageSettings
: The language settings for the response option
CitrusBuilder.ResponseScale
— TypeResponseScale <: AbstractSurveyComponent
A type representing a collection of ResponseOption
for a LimeSurvey question.
Fields
options::Vector{ResponseOption}
: A vector of response optionslanguage_settings::LanguageSettings
: The language settings for the response scale.
CitrusBuilder.SubQuestion
— TypeSubQuestion <: AbstractQuestion
A type representing subquestions of a LimeSurvey question.
Fields
id::String
: An alphanumeric question id. Must start with a letter.question::String
: The subquestion title.type::String
: The LimeSurvey qusetion typerelevance::String
: A LimeSurvey Expression Script
CitrusBuilder.Survey
— TypeSurvey <: AbstractSurveyComponent
A type to represent a LimeSurvey.
Fields
id::Int
: A valid LimeSurvey survey idlanguage_settings::LanguageSettings
: The surveys language settingschildren::Vector{QuestionGroup}
: A vector of question groupssettings::Dict{String,Any}
: Additional survey settings