SampleRule class - Revision history

Administrator at 09:41, 11 May 2022

2022-05-11T09:41:45Z

@@ Line 59: / Line 59: @@
 	print(sampleRule[i].SizeWithoutData );
+}
 </source>

Administrator at 09:49, 25 April 2022

2022-04-25T09:49:29Z

← Older revision		Revision as of 09:49, 25 April 2022
Line 3:		Line 3:
	\|Description=<nowiki>Represents a SampleRule.</nowiki>		\|Description=<nowiki>Represents a SampleRule.</nowiki>
	\|InheritsFrom=object\|Constructors=		\|InheritsFrom=object\|Constructors=
			{{CGscriptConstructors_Template\|Parameters=
			{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>id</nowiki>\|Description=<nowiki>Sample rule resource id</nowiki>}}
			\|Description=<nowiki>Fetch exist sample rule</nowiki>}}
	{{CGscriptConstructors_Template\|Parameters=		{{CGscriptConstructors_Template\|Parameters=
	{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of rule</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>questionnaireResourceId</nowiki>\|Description=<nowiki>Resource id of questionnaire to sample to</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>groupResourceId</nowiki>\|Description=<nowiki>Resource id of group to sample</nowiki>}}		{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of rule</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>questionnaireResourceId</nowiki>\|Description=<nowiki>Resource id of questionnaire to sample to</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>groupResourceId</nowiki>\|Description=<nowiki>Resource id of group to sample</nowiki>}}
	\|Description=<nowiki>Create new group samplerule</nowiki>}}		\|Description=<nowiki>Create new group samplerule</nowiki>}}
			{{CGscriptConstructors_Template\|Parameters=
			{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of rule</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=Questionnaire\|Name=<nowiki>questionnaire</nowiki>\|Description=<nowiki>The questionnaire contains this sample rule</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>groupId</nowiki>\|Description=<nowiki>Resource id of group to sample</nowiki>}}
			\|Description=<nowiki>Create and add new group sample rule to questionnaire object</nowiki>}}
	\|Methods=		\|Methods=
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Rebuild</nowiki>\|Description=<nowiki>Rebuild sample rule</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Save</nowiki>\|Description=<nowiki>Save the Samplerule</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Save</nowiki>\|Description=<nowiki>Save the Samplerule</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Inherited=object\|Description=<nowiki>The string representation of the object.</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Inherited=object\|Description=<nowiki>The string representation of the object.</nowiki>}}
Line 16:		Line 23:
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>GroupId</nowiki>\|HasGetter=1\|Description=<nowiki>Get id of group associated with this samplerule</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>GroupId</nowiki>\|HasGetter=1\|Description=<nowiki>Get id of group associated with this samplerule</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>GroupResourceId</nowiki>\|HasGetter=1\|Description=<nowiki>Get resourceId of group associated with this samplerule</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>GroupResourceId</nowiki>\|HasGetter=1\|Description=<nowiki>Get resourceId of group associated with this samplerule</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Id</nowiki>\|HasGetter=1\|Description=<nowiki>Resource id of sample rule</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>Name</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the Name of Samplerule.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>Name</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the Name of Samplerule.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>ObjectTypeName</nowiki>\|HasGetter=1\|Description=<nowiki>The name of the type of object.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>ObjectTypeName</nowiki>\|HasGetter=1\|Description=<nowiki>The name of the type of object.</nowiki>}}

Administrator at 07:24, 2 July 2020

2020-07-02T07:24:53Z

← Older revision		Revision as of 07:24, 2 July 2020
Line 2:		Line 2:
	\|Name=<nowiki>SampleRule</nowiki>		\|Name=<nowiki>SampleRule</nowiki>
	\|Description=<nowiki>Represents a SampleRule.</nowiki>		\|Description=<nowiki>Represents a SampleRule.</nowiki>
	\|Constructors=		\|InheritsFrom=object\|Constructors=
	{{CGscriptConstructors_Template\|Parameters=		{{CGscriptConstructors_Template\|Parameters=
	{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of rule</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>questionnaireResourceId</nowiki>\|Description=<nowiki>Resource id of questionnaire to sample to</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>groupResourceId</nowiki>\|Description=<nowiki>Resource id of group to sample</nowiki>}}		{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of rule</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>questionnaireResourceId</nowiki>\|Description=<nowiki>Resource id of questionnaire to sample to</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>groupResourceId</nowiki>\|Description=<nowiki>Resource id of group to sample</nowiki>}}
Line 8:		Line 8:
	\|Methods=		\|Methods=
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Save</nowiki>\|Description=<nowiki>Save the Samplerule</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Save</nowiki>\|Description=<nowiki>Save the Samplerule</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Description=<nowiki>The string representation of the object.</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Inherited=object\|Description=<nowiki>The string representation of the object.</nowiki>}}
	\|Properties=		\|Properties=
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>Active</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set if the SampleRule is active or not</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>Active</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set if the SampleRule is active or not</nowiki>}}
Line 24:		Line 24:
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>SizeWithData</nowiki>\|HasGetter=1\|Description=<nowiki>Get how many qas for this rule have data</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>SizeWithData</nowiki>\|HasGetter=1\|Description=<nowiki>Get how many qas for this rule have data</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>SizeWithoutData</nowiki>\|HasGetter=1\|Description=<nowiki>Get how many qas for this rule does not have data</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>SizeWithoutData</nowiki>\|HasGetter=1\|Description=<nowiki>Get how many qas for this rule does not have data</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=<nowiki>TypeInformation</nowiki>\|HasGetter=1\|Description=<nowiki>Get information about this class.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=<nowiki>TypeInformation</nowiki>\|HasGetter=1\|Inherited=object\|Description=<nowiki>Get information about this class.</nowiki>}}
	\|StaticMethods=		\|StaticMethods=
	{{CGscriptMethods_Template\|ReturnType=Array of SampleRule\|Name=<nowiki>SampleRule_getByGroupResourceId</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=Array of SampleRule\|Name=<nowiki>SampleRule_getByGroupResourceId</nowiki>\|Parameters=
Line 36:		Line 36:
	\|Description=<nowiki>Rebuild the samples in the given sample rules</nowiki>}}		\|Description=<nowiki>Rebuild the samples in the given sample rules</nowiki>}}
	}}		}}


	=== <span style="color:#DF8621">'''Examples'''</span> ===		=== <span style="color:#DF8621">'''Examples'''</span> ===

Administrator at 02:39, 30 January 2019

2019-01-30T02:39:32Z

← Older revision		Revision as of 02:39, 30 January 2019
Line 28:		Line 28:
	{{CGscriptMethods_Template\|ReturnType=Array of SampleRule\|Name=<nowiki>SampleRule_getByGroupResourceId</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=Array of SampleRule\|Name=<nowiki>SampleRule_getByGroupResourceId</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>groupResourceId</nowiki>\|Description=<nowiki>Resource id of the group to get samples from</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>groupResourceId</nowiki>\|Description=<nowiki>Resource id of the group to get samples from</nowiki>}}
	\|Description=<nowiki>Get all sample rules ~~associacted~~ with a group</nowiki>}}		\|Description=<nowiki>Get all sample rules associated with a group</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=Array of SampleRule\|Name=<nowiki>~~SampleRule_getByProjectQuestionnaire~~</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=Array of SampleRule\|Name=<nowiki>SampleRule_getByQuestionnaireResourceId</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>questionnaireResourceId</nowiki>\|Description=<nowiki>Resource id of the questionnaire to get samples from</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>questionnaireResourceId</nowiki>\|Description=<nowiki>Resource id of the questionnaire to get samples from</nowiki>}}
	\|Description=<nowiki>Get all sample rules ~~associacted~~ with a group</nowiki>}}		\|Description=<nowiki>Get all sample rules associated with a group</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SampleRule_rebuild</nowiki>\|Parameters=		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SampleRule_rebuild</nowiki>\|Parameters=
	{{CGscriptParameters_Template\|Type=Array of SampleRule\|Name=<nowiki>samplesRules</nowiki>\|Description=<nowiki>Sample rules to rebuild samples for</nowiki>}}		{{CGscriptParameters_Template\|Type=Array of SampleRule\|Name=<nowiki>samplesRules</nowiki>\|Description=<nowiki>Sample rules to rebuild samples for</nowiki>}}
	\|Description=<nowiki>Rebuild the samples in the given sample rules</nowiki>}}		\|Description=<nowiki>Rebuild the samples in the given sample rules</nowiki>}}
	}}		}}


	=== <span style="color:#DF8621">'''Examples'''</span> ===		=== <span style="color:#DF8621">'''Examples'''</span> ===

Administrator at 08:52, 29 January 2019

2019-01-29T08:52:33Z

← Older revision		Revision as of 08:52, 29 January 2019
Line 2:		Line 2:
	\|Name=<nowiki>SampleRule</nowiki>		\|Name=<nowiki>SampleRule</nowiki>
	\|Description=<nowiki>Represents a SampleRule.</nowiki>		\|Description=<nowiki>Represents a SampleRule.</nowiki>
			\|Constructors=
			{{CGscriptConstructors_Template\|Parameters=
			{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of rule</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>questionnaireResourceId</nowiki>\|Description=<nowiki>Resource id of questionnaire to sample to</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>groupResourceId</nowiki>\|Description=<nowiki>Resource id of group to sample</nowiki>}}
			\|Description=<nowiki>Create new group samplerule</nowiki>}}
	\|Methods=		\|Methods=
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Save</nowiki>\|Description=<nowiki>Save ~~SampleRule~~</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Save</nowiki>\|Description=<nowiki>Save the Samplerule</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Description=<nowiki>The string representation of the object.</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Description=<nowiki>The string representation of the object.</nowiki>}}
	\|Properties=		\|Properties=
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>Active</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set if the SampleRule is active or not</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>Active</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set if the SampleRule is active or not</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>ActualSize</nowiki>\|HasGetter=1\|Description=<nowiki>Get ~~the ActualSize of Samplerule~~</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>ActualSize</nowiki>\|HasGetter=1\|Description=<nowiki>Get how many qas is currently sampled for this rule.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=DateTime\|Name=<nowiki>DeletedDate</nowiki>\|HasGetter=1\|Description=<nowiki>Get/Set the DeletedDate of Samplerule</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=DateTime\|Name=<nowiki>DeletedDate</nowiki>\|HasGetter=1\|Description=<nowiki>Get/Set the DeletedDate of Samplerule</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>Description</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the Description of Samplerule</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>Description</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the Description of Samplerule</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>Name</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the Name of Samplerule</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>GroupId</nowiki>\|HasGetter=1\|Description=<nowiki>Get id of group associated with this samplerule</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>GroupResourceId</nowiki>\|HasGetter=1\|Description=<nowiki>Get resourceId of group associated with this samplerule</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>Name</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the Name of Samplerule.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>ObjectTypeName</nowiki>\|HasGetter=1\|Description=<nowiki>The name of the type of object.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>ObjectTypeName</nowiki>\|HasGetter=1\|Description=<nowiki>The name of the type of object.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>SampleRuleType</nowiki>\|HasGetter=1\|Description=<nowiki>Get the Type of Samplerule</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>QuestionnaireId</nowiki>\|HasGetter=1\|Description=<nowiki>Get id of questionnaire associated with this samplerule</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>SizeWithData</nowiki>\|HasGetter=1\|Description=<nowiki>Get ~~the SizeWithData of Samplerule~~</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>QuestionnaireResourceId</nowiki>\|HasGetter=1\|Description=<nowiki>Get resourceId of questionnaire associated with this samplerule</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>SizeWithoutData</nowiki>\|HasGetter=1\|Description=<nowiki>Get ~~the SizeWithoutData of Samplerule~~</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>RequestedSize</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get how many qas is requested to sample for this rule.</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>SampleRuleType</nowiki>\|HasGetter=1\|Description=<nowiki>Get the Type of Samplerule.</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>SizeWithData</nowiki>\|HasGetter=1\|Description=<nowiki>Get how many qas for this rule have data</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>SizeWithoutData</nowiki>\|HasGetter=1\|Description=<nowiki>Get how many qas for this rule does not have data</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=<nowiki>TypeInformation</nowiki>\|HasGetter=1\|Description=<nowiki>Get information about this class.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=<nowiki>TypeInformation</nowiki>\|HasGetter=1\|Description=<nowiki>Get information about this class.</nowiki>}}
	\|StaticMethods=		\|StaticMethods=
Line 20:		Line 29:
	{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>groupResourceId</nowiki>\|Description=<nowiki>Resource id of the group to get samples from</nowiki>}}		{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>groupResourceId</nowiki>\|Description=<nowiki>Resource id of the group to get samples from</nowiki>}}
	\|Description=<nowiki>Get all sample rules associacted with a group</nowiki>}}		\|Description=<nowiki>Get all sample rules associacted with a group</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Array of SampleRule\|Name=<nowiki>SampleRule_getByProjectQuestionnaire</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>questionnaireResourceId</nowiki>\|Description=<nowiki>Resource id of the questionnaire to get samples from</nowiki>}}
			\|Description=<nowiki>Get all sample rules associacted with a group</nowiki>}}
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>SampleRule_rebuild</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=Array of SampleRule\|Name=<nowiki>samplesRules</nowiki>\|Description=<nowiki>Sample rules to rebuild samples for</nowiki>}}
			\|Description=<nowiki>Rebuild the samples in the given sample rules</nowiki>}}
	}}		}}

	=== <span style="color:#DF8621">'''Examples'''</span> ===		=== <span style="color:#DF8621">'''Examples'''</span> ===
	<source lang="javascript">		<source lang="javascript">

Administrator at 10:28, 17 January 2019

2019-01-17T10:28:30Z

← Older revision		Revision as of 10:28, 17 January 2019
Line 21:		Line 21:
	\|Description=<nowiki>Get all sample rules associacted with a group</nowiki>}}		\|Description=<nowiki>Get all sample rules associacted with a group</nowiki>}}
	}}		}}
			=== <span style="color:#DF8621">'''Examples'''</span> ===
			<source lang="javascript">
			number groupRId = 15644390;
			array sampleRule = SampleRule_getByGroupResourceId(groupRId);
			for(number i = 0; i<sampleRule.Count; i++)
			{
			print(sampleRule[i].Active);
			print(sampleRule[i].ActualSize);
			print(sampleRule[i].DeletedDate);
			print(sampleRule[i].Description);
			print(sampleRule[i].SampleRuleType );
			print(sampleRule[i].SizeWithData );
			print(sampleRule[i].SizeWithoutData );
			}
			</source>

Administrator at 10:09, 17 January 2019

2019-01-17T10:09:52Z

← Older revision		Revision as of 10:09, 17 January 2019
Line 8:		Line 8:
	{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>Active</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set if the SampleRule is active or not</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>Active</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set if the SampleRule is active or not</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>ActualSize</nowiki>\|HasGetter=1\|Description=<nowiki>Get the ActualSize of Samplerule</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>ActualSize</nowiki>\|HasGetter=1\|Description=<nowiki>Get the ActualSize of Samplerule</nowiki>}}
	~~{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>AllowNewNumbers</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the AllowNewNumbers</nowiki>}}~~		{{CGscriptProperties_Template\|ReturnType=DateTime\|Name=<nowiki>DeletedDate</nowiki>\|HasGetter=1\|Description=<nowiki>Get/Set the DeletedDate of Samplerule</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=DateTime\|Name=<nowiki>DeletedDate</nowiki>\|HasGetter~~=1\|HasSetter~~=1\|Description=<nowiki>Get/Set the DeletedDate of Samplerule</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>Description</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the Description of Samplerule</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>Description</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the Description of Samplerule</nowiki>}}
	~~{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>EmailRequired</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the EmailRequired</nowiki>}}~~
	~~{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>FinalPanelExpectedTarget</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the Target of FinalPanelExpectedTarget</nowiki>}}~~
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>Name</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the Name of Samplerule</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>Name</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the Name of Samplerule</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>ObjectTypeName</nowiki>\|HasGetter=1\|Description=<nowiki>The name of the type of object.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>ObjectTypeName</nowiki>\|HasGetter=1\|Description=<nowiki>The name of the type of object.</nowiki>}}
	~~{{CGscriptProperties_Template\|ReturnType=number\|Name=<nowiki>Percentage</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the Percentage of Samplerule</nowiki>}}~~
	~~{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>PhoneNumberRequired</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the PhoneNumberRequired</nowiki>}}~~
	~~{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>RedirectLink</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the RedirectLink of Samplerule</nowiki>}}~~
	~~{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>RequestedSize</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the RequestedSize of Samplerule</nowiki>}}~~
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>SampleRuleType</nowiki>\|HasGetter=1\|Description=<nowiki>Get the Type of Samplerule</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>SampleRuleType</nowiki>\|HasGetter=1\|Description=<nowiki>Get the Type of Samplerule</nowiki>}}
	~~{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>SiteId</nowiki>\|HasGetter=1\|Description=<nowiki>Get the SiteId of Samplerule</nowiki>}}~~
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>SizeWithData</nowiki>\|HasGetter=1\|Description=<nowiki>Get the SizeWithData of Samplerule</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>SizeWithData</nowiki>\|HasGetter=1\|Description=<nowiki>Get the SizeWithData of Samplerule</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>SizeWithoutData</nowiki>\|HasGetter=1\|Description=<nowiki>Get the SizeWithoutData of Samplerule</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>SizeWithoutData</nowiki>\|HasGetter=1\|Description=<nowiki>Get the SizeWithoutData of Samplerule</nowiki>}}
	~~{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Target</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the Target of Samplerule</nowiki>}}~~
	{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=<nowiki>TypeInformation</nowiki>\|HasGetter=1\|Description=<nowiki>Get information about this class.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=<nowiki>TypeInformation</nowiki>\|HasGetter=1\|Description=<nowiki>Get information about this class.</nowiki>}}
			\|StaticMethods=
			{{CGscriptMethods_Template\|ReturnType=Array of SampleRule\|Name=<nowiki>SampleRule_getByGroupResourceId</nowiki>\|Parameters=
			{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>groupResourceId</nowiki>\|Description=<nowiki>Resource id of the group to get samples from</nowiki>}}
			\|Description=<nowiki>Get all sample rules associacted with a group</nowiki>}}
	}}		}}

Nguyenduyan: Created page with "{{CGscriptClass_Template |Name=SampleRule |Description=Represents a SampleRule. |Methods= {{CGscriptMethods_Template|ReturnType=Empty|Name=
2018-04-02T10:03:56Z

Created page with "{{CGscriptClass_Template |Name=<nowiki>SampleRule</nowiki> |Description=<nowiki>Represents a SampleRule.</nowiki> |Methods= {{CGscriptMethods_Template|ReturnType=Empty|Name=<n..."

New page
{{CGscriptClass_Template
|Name=<nowiki>SampleRule</nowiki>
|Description=<nowiki>Represents a SampleRule.</nowiki>
|Methods=
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>Save</nowiki>|Description=<nowiki>Save SampleRule</nowiki>}}
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Active</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set if the SampleRule is active or not</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>ActualSize</nowiki>|HasGetter=1|Description=<nowiki>Get the ActualSize of Samplerule</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>AllowNewNumbers</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the AllowNewNumbers</nowiki>}}
{{CGscriptProperties_Template|ReturnType=DateTime|Name=<nowiki>DeletedDate</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the DeletedDate of Samplerule</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Description</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the Description of Samplerule</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>EmailRequired</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the EmailRequired</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>FinalPanelExpectedTarget</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the Target of FinalPanelExpectedTarget</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Name</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the Name of Samplerule</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Percentage</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the Percentage of Samplerule</nowiki>}}
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>PhoneNumberRequired</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the PhoneNumberRequired</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>RedirectLink</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the RedirectLink of Samplerule</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>RequestedSize</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the RequestedSize of Samplerule</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>SampleRuleType</nowiki>|HasGetter=1|Description=<nowiki>Get the Type of Samplerule</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>SiteId</nowiki>|HasGetter=1|Description=<nowiki>Get the SiteId of Samplerule</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>SizeWithData</nowiki>|HasGetter=1|Description=<nowiki>Get the SizeWithData of Samplerule</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>SizeWithoutData</nowiki>|HasGetter=1|Description=<nowiki>Get the SizeWithoutData of Samplerule</nowiki>}}
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>Target</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Get/Set the Target of Samplerule</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}
}}

← Older revision		Revision as of 09:49, 25 April 2022
Line 3:		Line 3:
	\|Description=<nowiki>Represents a SampleRule.</nowiki>		\|Description=<nowiki>Represents a SampleRule.</nowiki>
	\|InheritsFrom=object\|Constructors=		\|InheritsFrom=object\|Constructors=
			{{CGscriptConstructors_Template\|Parameters=
			{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>id</nowiki>\|Description=<nowiki>Sample rule resource id</nowiki>}}
			\|Description=<nowiki>Fetch exist sample rule</nowiki>}}
	{{CGscriptConstructors_Template\|Parameters=		{{CGscriptConstructors_Template\|Parameters=
	{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of rule</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>questionnaireResourceId</nowiki>\|Description=<nowiki>Resource id of questionnaire to sample to</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>groupResourceId</nowiki>\|Description=<nowiki>Resource id of group to sample</nowiki>}}		{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of rule</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>questionnaireResourceId</nowiki>\|Description=<nowiki>Resource id of questionnaire to sample to</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>groupResourceId</nowiki>\|Description=<nowiki>Resource id of group to sample</nowiki>}}
	\|Description=<nowiki>Create new group samplerule</nowiki>}}		\|Description=<nowiki>Create new group samplerule</nowiki>}}
			{{CGscriptConstructors_Template\|Parameters=
			{{CGscriptParameters_Template\|Type=string\|Name=<nowiki>name</nowiki>\|Description=<nowiki>Name of rule</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=Questionnaire\|Name=<nowiki>questionnaire</nowiki>\|Description=<nowiki>The questionnaire contains this sample rule</nowiki>\|Comma=,}}{{CGscriptParameters_Template\|Type=int\|Name=<nowiki>groupId</nowiki>\|Description=<nowiki>Resource id of group to sample</nowiki>}}
			\|Description=<nowiki>Create and add new group sample rule to questionnaire object</nowiki>}}
	\|Methods=		\|Methods=
			{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Rebuild</nowiki>\|Description=<nowiki>Rebuild sample rule</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Save</nowiki>\|Description=<nowiki>Save the Samplerule</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=Empty\|Name=<nowiki>Save</nowiki>\|Description=<nowiki>Save the Samplerule</nowiki>}}
	{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Inherited=object\|Description=<nowiki>The string representation of the object.</nowiki>}}		{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|Inherited=object\|Description=<nowiki>The string representation of the object.</nowiki>}}
Line 16:		Line 23:
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>GroupId</nowiki>\|HasGetter=1\|Description=<nowiki>Get id of group associated with this samplerule</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>GroupId</nowiki>\|HasGetter=1\|Description=<nowiki>Get id of group associated with this samplerule</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>GroupResourceId</nowiki>\|HasGetter=1\|Description=<nowiki>Get resourceId of group associated with this samplerule</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>GroupResourceId</nowiki>\|HasGetter=1\|Description=<nowiki>Get resourceId of group associated with this samplerule</nowiki>}}
			{{CGscriptProperties_Template\|ReturnType=int\|Name=<nowiki>Id</nowiki>\|HasGetter=1\|Description=<nowiki>Resource id of sample rule</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>Name</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the Name of Samplerule.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>Name</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Get/Set the Name of Samplerule.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>ObjectTypeName</nowiki>\|HasGetter=1\|Description=<nowiki>The name of the type of object.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=string\|Name=<nowiki>ObjectTypeName</nowiki>\|HasGetter=1\|Description=<nowiki>The name of the type of object.</nowiki>}}