Return
Syntax
Return(<sample_management_name> As String, <sample_record_xml> As String, <return_code_xml> As String, <properties_xml> As String, Optional <quota_engine> as Variant) As SampleManagementResultXml
Type
Method
Parameters
<sample_management_name>
The name of the sample management object.
<sample_record_xml>
The sample record to return as XML.
<return_code_xml>
The return code as XML.
<properties_xml>
The project, interview, interviewer, and station properties as SampleManagementXml.
<quota_engine>
Optional. A QuotaEngine for the project.
Return value
SampleManagementResultXml
Description
This method is called when the interviewer selects a return code for a connected or manually dialed call. This description assumes group dialing and an implementation where the predictive algorithm is implemented by the dialer.
1 Hang up if not a timeout or shutdown and connected. A timeout occurs if the interviewer stays on the same page for a long period of time. Timeouts cause the interview objects to be unloaded to save resources. Avoid hang up on shutdown in case the shutdown is caused by an application pool shutdown. The interview might fail over to a new session engine so we do not want to hangup the call with the respondent.
2 Send the return code to the dialer if necessary for dialer specific reports.
3 Call the specific sample management provider’s Return method to return the sample record.
See also