Latest revision as of 06:35, 20 September 2026

QcsSampleRuleColumn

Represents a data cache specification column with sample rule data.

Parent class

Inherits from QcsColumn

Constructors

(int sampleRuleResourceId "Set the associated sample rule.", int questionnaireResourceId "Set the associated questionnaire. Set to 0 to use primary questionnaire", DataCacheSpecification dcs "Dcs the column should belong to") - Create a new column.
(int sampleRuleResourceId "Set the associated sample rule.", int questionnaireResourceId "Set the associated questionnaire. Set to 0 to use primary questionnaire", string name "Set the name of the column in the dcs.", DataCacheSpecification dcs "Dcs the column should belong to") - Create a new column with an explicit name.

Methods

Empty ChangeDcs(DataCacheSpecification dcs "New DCS to put the column in") - Change column to belong to another DCS. The origin DCS is not altered
Empty Delete() - Remove column from the dcs
Empty Save() - Add a new column to the dcs. Naming conflicts are automatically resolved. Notice the dcs itself also needs to be saved
string ToString() - The string representation of the object.

Properties

string CgScript { get; set; } - Get/set the cgscript for the column
string ColumnType { get; } - Get the source type of the column data
string DataType { get; } - Get the data type of the column
bool IsPii { get; } - Whether the column is classified as PII
string Name { get; set; } - Get/set the name of the column
string ObjectTypeName { get; } - The name of the type of object.
bool PresentAsText { get; set; } - Get/set if Show the data column as the option text
int QuestionnaireResourceId { get; } - Get the questionnaire used for getting data for this column.
int SampleRuleResourceId { get; } - Get the sample rule used for getting data for this column.
TypeInformation TypeInformation { get; } - Get information about this class.

@@ Line 2: / Line 2: @@
 |Name=<nowiki>QcsSampleRuleColumn</nowiki>
 |Description=<nowiki>Represents a data cache specification column with sample rule data.</nowiki>
+|InheritsFrom=QcsColumn|Constructors=
+{{CGscriptConstructors_Template|Parameters=
+{{CGscriptParameters_Template|Type=int|Name=<nowiki>sampleRuleResourceId</nowiki>|Description=<nowiki>Set the associated sample rule.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>Set the associated questionnaire. Set to 0 to use primary questionnaire</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>Dcs the column should belong to</nowiki>}}
+|Description=<nowiki>Create a new column.</nowiki>}}
+{{CGscriptConstructors_Template|Parameters=
+{{CGscriptParameters_Template|Type=int|Name=<nowiki>sampleRuleResourceId</nowiki>|Description=<nowiki>Set the associated sample rule.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=<nowiki>questionnaireResourceId</nowiki>|Description=<nowiki>Set the associated questionnaire. Set to 0 to use primary questionnaire</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=string|Name=<nowiki>name</nowiki>|Description=<nowiki>Set the name of the column in the dcs.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>Dcs the column should belong to</nowiki>}}
+|Description=<nowiki>Create a new column with an explicit name.</nowiki>}}
 |Methods=
+{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>ChangeDcs</nowiki>|Parameters=
+{{CGscriptParameters_Template|Type=DataCacheSpecification|Name=<nowiki>dcs</nowiki>|Description=<nowiki>New DCS to put the column in</nowiki>}}
+|Description=<nowiki>Change column to belong to another DCS. The origin DCS is not altered</nowiki>}}
 {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Delete</nowiki>|Description=<nowiki>Remove column from the dcs</nowiki>}}
 {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Add a new column to the dcs. Naming conflicts are automatically resolved. Notice the dcs itself also needs to be saved</nowiki>}}
@@ Line 10: / Line 20: @@
 {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ColumnType</nowiki>|HasGetter=1|Description=<nowiki>Get the source type of the column data</nowiki>}}
 {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>DataType</nowiki>|HasGetter=1|Description=<nowiki>Get the data type of the column</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IsPii</nowiki>|HasGetter=1|Description=<nowiki>Whether the column is classified as PII</nowiki>}}
 {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set the name of the column</nowiki>}}
 {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
 {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>PresentAsText</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/set if Show the data column as the option text</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|HasGetter=1|Description=<nowiki>Get the questionnaire used for getting data for this column.</nowiki>}}
+{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>SampleRuleResourceId</nowiki>|HasGetter=1|Description=<nowiki>Get the sample rule used for getting data for this column.</nowiki>}}
 {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
 }}
+[[File:2018-11-07_16-09-57.png]]