Survey

public class Survey extends AbstractShadowableRdcDomainObject

A survey is conducted to examine a population on the basis of a sample. The resulting DataSets 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

private Period fieldPeriod

The period during which the survey has been conducted or is expected to be conducted. Must not be empty.

grossSampleSize

private Integer grossSampleSize

The gross sample size represents the number of participants which have been invited to take part in the Survey. Must not be negative.

id

private String id

The id of the survey which uniquely identifies the survey in this application.

masterId

private String masterId

The master id of the survey. It must not be empty, must be of the form sur-{{dataAcquisitionProjectId}}-sy{{number}}$ and must not contain more than 512 characters.

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

private Double responseRate

The response rate is the quotient of the gross sample size and the sample size. Must be between 0 and 100.

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

private Integer sampleSize

The sample size is the number of participant which took part in the survey. Must not be empty and must not be negative.

serialVersionUID

private static final long serialVersionUID

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 the DataPackage is not organized in waves. Must not be empty and must be greater than or equal to 1.