Difference between revisions of "CatiQasSearchQuery class"
(Created page with "{{CGscriptClass_Template |Name=<nowiki>CatiQasSearchQuery</nowiki> |Description=<nowiki>Search for qas in cati questionnaire.</nowiki> |Methods= {{CGscriptMethods_Template|Ret...") |
|||
| Line 2: | Line 2: | ||
|Name=<nowiki>CatiQasSearchQuery</nowiki> | |Name=<nowiki>CatiQasSearchQuery</nowiki> | ||
|Description=<nowiki>Search for qas in cati questionnaire.</nowiki> | |Description=<nowiki>Search for qas in cati questionnaire.</nowiki> | ||
| − | |Methods= | + | |InheritsFrom=object|Methods= |
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AppointmentsInTimeRange</nowiki>|Parameters= | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>AppointmentsInTimeRange</nowiki>|Parameters= | ||
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>fromDate</nowiki>|Description=<nowiki>Select qas with appointments from this datetime. May be empty.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>toDate</nowiki>|Description=<nowiki>Select qas with appointments to this datetime. May be empty.</nowiki>}} | {{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>fromDate</nowiki>|Description=<nowiki>Select qas with appointments from this datetime. May be empty.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>toDate</nowiki>|Description=<nowiki>Select qas with appointments to this datetime. May be empty.</nowiki>}} | ||
| Line 12: | Line 12: | ||
{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>fromDate</nowiki>|Description=<nowiki>Select qas with appointments from this datetime. May be empty.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>toDate</nowiki>|Description=<nowiki>Select qas with appointments to this datetime. May be empty.</nowiki>}} | {{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>fromDate</nowiki>|Description=<nowiki>Select qas with appointments from this datetime. May be empty.</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=<nowiki>toDate</nowiki>|Description=<nowiki>Select qas with appointments to this datetime. May be empty.</nowiki>}} | ||
|Description=<nowiki>Set date range for End date.</nowiki>}} | |Description=<nowiki>Set date range for End date.</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>AllowNoPhone</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Include those without phonenumbers in the result</nowiki>}} | {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>AllowNoPhone</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Include those without phonenumbers in the result</nowiki>}} | ||
| Line 20: | Line 20: | ||
{{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=bool|Name=<nowiki>RestrictToDedicatedSamples</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Only include results in the samples the current user is dedicated to</nowiki>}} | {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>RestrictToDedicatedSamples</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Only include results in the samples the current user is dedicated to</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>}} |
}} | }} | ||
Latest revision as of 07:33, 2 July 2020
CatiQasSearchQuery
Search for qas in cati questionnaire.
Parent class
Inherits from object
Methods
- Empty AppointmentsInTimeRange(DateTime fromDate "Select qas with appointments from this datetime. May be empty.", DateTime toDate "Select qas with appointments to this datetime. May be empty.") - Set date range for NextContactTime.
- Array of QAS Execute(int pageSize "How many items to fetch", int page "Which page to fetch records for") - Get list of qas on the given list.
- Empty FinishedInTimeRange(DateTime fromDate "Select qas with appointments from this datetime. May be empty.", DateTime toDate "Select qas with appointments to this datetime. May be empty.") - Set date range for End date.
- (From object) string ToString() - The string representation of the object.
Properties
- bool AllowNoPhone { get; set; } - Include those without phonenumbers in the result
- CatiListType constant CatiListType { get; set; } - Which list to return
- int Count { get; } - Get count of qas on the given list.
- bool IsInterviewer { get; set; } - Only include the numbers the interviewer will dial
- string ObjectTypeName { get; } - The name of the type of object.
- bool RestrictToDedicatedSamples { get; set; } - Only include results in the samples the current user is dedicated to
- (From object) TypeInformation TypeInformation { get; } - Get information about this class.
