Difference between revisions of "FieldWorkManagement class"
(Created page with "{{CGscriptClass_Template |Name=<nowiki>FieldWorkManagement</nowiki> |Description=<nowiki>Manage cati questionnaire.</nowiki> |Constructors= {{CGscriptConstructors_Template|Par...") |
|||
| Line 10: | Line 10: | ||
{{CGscriptParameters_Template|Type=SampleRule|Name=<nowiki>sr</nowiki>|Description=<nowiki>Samplerule to restrict to.</nowiki>}} | {{CGscriptParameters_Template|Type=SampleRule|Name=<nowiki>sr</nowiki>|Description=<nowiki>Samplerule to restrict to.</nowiki>}} | ||
|Description=<nowiki>Restrict interviewer to only allow access to a specific sample. Return false if already restricted.</nowiki>}} | |Description=<nowiki>Restrict interviewer to only allow access to a specific sample. Return false if already restricted.</nowiki>}} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
{{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>EnsureEmployeeAssignmentRecord</nowiki>|Description=<nowiki>Ensure current interviewer has an active Employee Assignment record for today. Startdate will be set to now, if none exists. Return true when made new record.</nowiki>}} | {{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>EnsureEmployeeAssignmentRecord</nowiki>|Description=<nowiki>Ensure current interviewer has an active Employee Assignment record for today. Startdate will be set to now, if none exists. Return true when made new record.</nowiki>}} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
{{CGscriptMethods_Template|ReturnType=Array of numbers|Name=<nowiki>ListOfInterviewers</nowiki>|Description=<nowiki>Get list of interviewers user resource ids with active Employee Assignment records today.</nowiki>}} | {{CGscriptMethods_Template|ReturnType=Array of numbers|Name=<nowiki>ListOfInterviewers</nowiki>|Description=<nowiki>Get list of interviewers user resource ids with active Employee Assignment records today.</nowiki>}} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
{{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemoveRestrictSampleTo</nowiki>|Parameters= | {{CGscriptMethods_Template|ReturnType=Empty|Name=<nowiki>RemoveRestrictSampleTo</nowiki>|Parameters= | ||
{{CGscriptParameters_Template|Type=SampleRule|Name=<nowiki>sr</nowiki>|Description=<nowiki>Samplerule to remove restrict to.</nowiki>}} | {{CGscriptParameters_Template|Type=SampleRule|Name=<nowiki>sr</nowiki>|Description=<nowiki>Samplerule to remove restrict to.</nowiki>}} | ||
|Description=<nowiki>Remove restrict interviewer to only allow access to a specific sample.</nowiki>}} | |Description=<nowiki>Remove restrict interviewer to only allow access to a specific sample.</nowiki>}} | ||
{{CGscriptMethods_Template|ReturnType=Array of SampleRule|Name=<nowiki>RestrictSampleToList</nowiki>|Description=<nowiki>List of samples interviewer is restricted to. None means access to all.</nowiki>}} | {{CGscriptMethods_Template|ReturnType=Array of SampleRule|Name=<nowiki>RestrictSampleToList</nowiki>|Description=<nowiki>List of samples interviewer is restricted to. None means access to all.</nowiki>}} | ||
| − | {{CGscriptMethods_Template|ReturnType= | + | {{CGscriptMethods_Template|ReturnType=CatiQasSearchQuery|Name=<nowiki>SearchQuery</nowiki>|Parameters= |
| − | {{CGscriptParameters_Template|Type=int|Name=<nowiki> | + | {{CGscriptParameters_Template|Type=int|Name=<nowiki>catiList</nowiki>|Description=<nowiki>Which list to return</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>allowNoPhone</nowiki>|Description=<nowiki>Include those without phonenumbers in the result</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=<nowiki>forInterviewer</nowiki>|Description=<nowiki>Show only those for specified interviewer. Also returns the value in the order they will be called</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Unknown|Name=<nowiki>restrictToSampleIds</nowiki>|Description=<nowiki>Restrict the search to the given list of samples. May be empty</nowiki>}} |
|Description=<nowiki>Get list of qas on the given list.</nowiki>}} | |Description=<nowiki>Get list of qas on the given list.</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= | ||
Revision as of 09:09, 12 February 2019
FieldWorkManagement
Manage cati questionnaire.
Constructors
- (int questionnaireResourceId "Resource id of the questionnaire", int interviewerResourceId "Resource id of the user that is interviewing. 0 to use current user") - Manage the given questionnaire and interviewer.
Methods
- bool AddRestrictSampleTo(SampleRule sr "Samplerule to restrict to.") - Restrict interviewer to only allow access to a specific sample. Return false if already restricted.
- bool EnsureEmployeeAssignmentRecord() - Ensure current interviewer has an active Employee Assignment record for today. Startdate will be set to now, if none exists. Return true when made new record.
- Array of number ListOfInterviewers() - Get list of interviewers user resource ids with active Employee Assignment records today.
- Empty RemoveRestrictSampleTo(SampleRule sr "Samplerule to remove restrict to.") - Remove restrict interviewer to only allow access to a specific sample.
- Array of SampleRule RestrictSampleToList() - List of samples interviewer is restricted to. None means access to all.
- CatiQasSearchQuery SearchQuery(int catiList "Which list to return", bool allowNoPhone "Include those without phonenumbers in the result", bool forInterviewer "Show only those for specified interviewer. Also returns the value in the order they will be called", Unknown restrictToSampleIds "Restrict the search to the given list of samples. May be empty") - Get list of qas on the given list.
- string ToString() - The string representation of the object.
Properties
- string ObjectTypeName { get; } - The name of the type of object.
- TypeInformation TypeInformation { get; } - Get information about this class.
