SampleRule class

SampleRule

Represents a SampleRule.

Parent class

Inherits from object

Constructors

• (int id "Sample rule resource id") - Fetch exist sample rule
  
• (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
  
• (string name "Name of rule", Questionnaire questionnaire "The questionnaire contains this sample rule", int groupId "Resource id of group to sample") - Create and add new group sample rule to questionnaire object
  

Methods

• Empty Rebuild() - Rebuild sample rule
  
• 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
  
• int Id { get; } - Resource id of sample rule
  
• 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 );
}

//add sameple to qnaire and rebuild 
Questionnaire qnaire = new Questionnaire (17148177);
number groupSample = 17146562;
SampleRule sampleRule = new SampleRule ("s1", qnaire, groupSample);
sampleRule.Save();
sampleRule.Rebuild();