Difference between revisions of "SampleRule class"
| 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> === | ||
Revision as of 09:24, 2 July 2020
SampleRule
Represents a SampleRule.
Parent class
Inherits from object
Constructors
- (string name "Name of rule", int questionnaireResourceId "Resource id of questionnaire to sample to", int groupResourceId "Resource id of group to sample") - Create new group samplerule
Methods
- Empty Save() - Save the Samplerule
- (From object) string ToString() - The string representation of the object.
Properties
- bool Active { get; set; } - Get/Set if the SampleRule is active or not
- int ActualSize { get; } - Get how many qas is currently sampled for this rule.
- DateTime DeletedDate { get; } - Get/Set the DeletedDate of Samplerule
- string Description { get; set; } - Get/Set the Description of Samplerule
- int GroupId { get; } - Get id of group associated with this samplerule
- int GroupResourceId { get; } - Get resourceId of group associated with this samplerule
- string Name { get; set; } - Get/Set the Name of Samplerule.
- string ObjectTypeName { get; } - The name of the type of object.
- int QuestionnaireId { get; } - Get id of questionnaire associated with this samplerule
- int QuestionnaireResourceId { get; } - Get resourceId of questionnaire associated with this samplerule
- int RequestedSize { get; set; } - Get how many qas is requested to sample for this rule.
- int SampleRuleType { get; } - Get the Type of Samplerule.
- int SizeWithData { get; } - Get how many qas for this rule have data
- int SizeWithoutData { get; } - Get how many qas for this rule does not have data
- (From object) TypeInformation TypeInformation { get; } - Get information about this class.
Static Methods
- Array of SampleRule SampleRule_getByGroupResourceId(int groupResourceId "Resource id of the group to get samples from") - Get all sample rules associated with a group
- Array of SampleRule SampleRule_getByQuestionnaireResourceId(int questionnaireResourceId "Resource id of the questionnaire to get samples from") - Get all sample rules associated with a group
- Empty SampleRule_rebuild(Array of SampleRule samplesRules "Sample rules to rebuild samples for") - Rebuild the samples in the given sample rules
Examples
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 );
}
