Survey¶
-
public class
Survey
extends AbstractShadowableRdcDomainObject¶ A survey is conducted to examine a population on the basis of a sample. The resulting
DataSet
s can be used to make statements about the population.
Fields¶
annotations¶
-
private I18nString
annotations
¶ Arbitrary additional text for this survey. Markdown is supported. Must not contain more than 2048 characters.
dataAcquisitionProjectId¶
-
private String
dataAcquisitionProjectId
¶ The id of the
DataAcquisitionProject
to which this survey belongs. The dataAcquisitionProjectId must not be empty.
dataPackageId¶
-
private String
dataPackageId
¶ The id of the
DataPackage
to which this survey belongs. Must not be empty.
dataType¶
-
private I18nString
dataType
¶ The type of data which the survey produced. Must be one of
DataTypes
and must not be empty.
fieldPeriod¶
grossSampleSize¶
id¶
masterId¶
number¶
-
private Integer
number
¶ The number of the instrument. Must not be empty and must be unique within the
DataAcquisitionProject
.
population¶
-
private Population
population
¶ Details about the
Population
. Must not be empty.
responseRate¶
sample¶
-
private I18nString
sample
¶ The sampling method is the procedure for selecting sample members from a population. It must match the controlled vocabulary specified by VFDB.
See also: ` Catalog: GNERD: Sampling Procedure Educational Research (Version 1.0) <https://mdr.iqb.hu-berlin.de/#/catalog/1d791cc7-6d8d-dd35-b1ef-0eec9c31bbb5“>`_
sampleSize¶
surveyMethod¶
-
private I18nString
surveyMethod
¶ The survey method briefly describes how the data were collected. It must be specified in German and English and it must not contain more than 2048 characters.
title¶
-
private I18nString
title
¶ The title of the instrument. It must be specified in German and English and it must not contain more than 2048 characters.
wave¶
-
private Integer
wave
¶ Number of the wave which this
Survey
represents. Will be ignored if theDataPackage
is not organized in waves. Must not be empty and must be greater than or equal to 1.