Difference between revisions of "GroupBuilderAnswerSheetStatusVariable class"

From Catglobe Wiki
Jump to: navigation, search
(Created page with "{{CGscriptClass_Template |Name=GroupBuilderAnswerSheetStatusVariable |Description=Represents a group builder variable for answersheet status. |Constructors= {{CGscriptConstruc...")
 
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
{{CGscriptClass_Template
 
{{CGscriptClass_Template
|Name=GroupBuilderAnswerSheetStatusVariable
+
|Name=<nowiki>GroupBuilderAnswerSheetStatusVariable</nowiki>
|Description=Represents a group builder variable for answersheet status.
+
|Description=<nowiki>Represents a group builder variable for answersheet status.</nowiki>
|Constructors=
+
|InheritsFrom=GroupBuilderVariable|Constructors=
{{CGscriptConstructors_Template|Description=Create new variable}}
+
{{CGscriptConstructors_Template|Description=<nowiki>Create new variable</nowiki>}}
 
|Methods=
 
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}}
+
{{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=Include|HasGetter=1|HasSetter=1|Description=Include users that match rule, or exclude}}
+
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Include</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Include users that match rule, or exclude</nowiki>}}
{{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}}
+
{{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=QuestionnaireResourceId|HasGetter=1|HasSetter=1|Description=Questionnaire to get users from}}
+
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>QuestionnaireResourceId</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Questionnaire to get users from</nowiki>}}
{{CGscriptProperties_Template|ReturnType=array|Name=Status|HasGetter=1|HasSetter=1|Description=Set which status to look for, use RPQ_Status_* constants}}
+
{{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>Status</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Set which status to look for, use RPQ_Status_* constants</nowiki>}}
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}}
+
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}
 
}}
 
}}
 +
 +
=== <span style="color:#DF8621">'''Examples'''</span> ===
 +
 +
<source lang="javascript">
 +
//Create a new group
 +
string groupName = "Test Group Builder: answerSheetStatusVariable ";
 +
number groupTemplateResourceId=2066;
 +
number parentResourceId = 11088827;
 +
array group = Group_new(groupName, groupTemplateResourceId, parentResourceId);
 +
Group_save(group);
 +
number groupRId = group[GROUP_RESOURCE_ID ];
 +
 +
//Create rule for the group
 +
GroupBuilderRoot root = new GroupBuilderRoot (groupRId);
 +
 +
GroupBuilderAnswerSheetStatusVariable answerSheetStatusVariable = new GroupBuilderAnswerSheetStatusVariable();
 +
answerSheetStatusVariable.Include=true;
 +
answerSheetStatusVariable.QuestionnaireResourceId=15546533;
 +
//array rpqStatus ={1,2,3,4,5};
 +
array rpqStatus ={RPQ_Status_Normal, RPQ_Status_QuotaFull, RPQ_Status_OutsideTarget, RPQ_Status_InterviewFailed,RPQ_Status_InterviewSucceeded};
 +
answerSheetStatusVariable.Status=rpqStatus;
 +
 +
GroupBuilderRule rule = new GroupBuilderRule (root);
 +
rule.Add(answerSheetStatusVariable);
 +
 +
GroupBuilderRuleCollection ruleColection = root.RootRules;
 +
ruleColection.Add(rule);
 +
 +
root.Save();
 +
</source>

Latest revision as of 08:49, 2 July 2020

GroupBuilderAnswerSheetStatusVariable


Represents a group builder variable for answersheet status.

Parent class

Inherits from GroupBuilderVariable

Constructors

  • () - Create new variable

Methods

  • (From object) string ToString() - The string representation of the object.

Properties

  • bool Include { get; set; } - Include users that match rule, or exclude
  • string ObjectTypeName { get; } - The name of the type of object.
  • int QuestionnaireResourceId { get; set; } - Questionnaire to get users from
  • array Status { get; set; } - Set which status to look for, use RPQ_Status_* constants
  • (From object) TypeInformation TypeInformation { get; } - Get information about this class.


Examples

//Create a new group
string groupName = "Test Group Builder: answerSheetStatusVariable ";
number groupTemplateResourceId=2066;
number parentResourceId = 11088827;
array group = Group_new(groupName, groupTemplateResourceId, parentResourceId);
Group_save(group);
number groupRId = group[GROUP_RESOURCE_ID ];
 
//Create rule for the group
GroupBuilderRoot root = new GroupBuilderRoot (groupRId); 

GroupBuilderAnswerSheetStatusVariable answerSheetStatusVariable = new GroupBuilderAnswerSheetStatusVariable();
answerSheetStatusVariable.Include=true;
answerSheetStatusVariable.QuestionnaireResourceId=15546533;
//array rpqStatus ={1,2,3,4,5};
array rpqStatus ={RPQ_Status_Normal, RPQ_Status_QuotaFull, RPQ_Status_OutsideTarget, RPQ_Status_InterviewFailed,RPQ_Status_InterviewSucceeded};
answerSheetStatusVariable.Status=rpqStatus;
 
GroupBuilderRule rule = new GroupBuilderRule (root);
rule.Add(answerSheetStatusVariable);
 
GroupBuilderRuleCollection ruleColection = root.RootRules;
ruleColection.Add(rule);
 
root.Save();