SAP ABAP Class CL_UWS_SURVEY_API (Survey API)

Hierarchy

☛ SAP_ABA (Software Component) Cross-Application Component
   ⤷ CA-SUR (Application Component) Web Survey
     ⤷ UWS_SURVEY (Package) Form-Based Web Services: Survey

Properties

Class	CL_UWS_SURVEY_API
Short Description	Survey API
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	UWS_SURVEY	Form-Based Web Services: Survey
Created	20070226	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	CL_UWS_FORM_PDF_API	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	CL_UWS_PUBLISHING	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_UWS_SURVEY_API has no interface implemented.

Friends

Class CL_UWS_SURVEY_API has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_CONF_PAGE	Constant	Public	☐	Type reference (TYPE)	STRING	'confirmation_page'		20111129
2	MD_APPLICATION	Instance attribute	Private	☐	Type reference (TYPE)	UXB_APPLICATION		Application	20070227
3	MR_SURVEY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_UWS_SURVEY		Persistant XML Object	20070226
4	MR_SURVEY_GROUP	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_UWS_SURVEY_GROUP_API		Survey groups	20070319
5	MR_TARGET_HIERARCHY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_UWS_TARGET_HIERARCHY		UXP: Persistant Object (String Content)	20070228

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_ATTRIBUTE	Instance method	Public	Method		20070301
2	ADD_GROUP	Instance method	Public	Method		20070228
3	ADD_HIER_NODE_MASS_DATA	Instance method	Protected	Method		20070227
4	ADD_MESSAGE	Instance method	Private	Method		20080620
5	ADD_RECIPIENT	Instance method	Public	Method		20070228
6	ADD_RECIPIENTS_AS_MASS_DATA	Instance method	Public	Method		20070227
7	ADD_RECIP_ATTR_MASS_DATA	Instance method	Public	Method		20070307
8	ADD_RECIP_CUST_ATTR_MASS_DATA	Instance method	Public	Method		20070307
9	ASSIGN_QUESTIONNAIRE	Instance method	Public	Method		20070302
10	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20070227
11	CREATE_QUESTIONNAIRE	Instance method	Private	Method		20070301
12	CREATE_SURVEY	Static method	Public	Method		20070227
13	DELETE_SURVEY	Instance method	Public	Method		20070315
14	DESTROY	Instance method	Public	Method		20080114
15	GET_ALL_QUESTIONNAIRES	Static method	Public	Method		20070315
16	GET_ASSIGNED_QUESTIONNAIRES	Instance method	Public	Method		20070302
17	GET_CONFIRMATION_PAGE	Instance method	Public	Method		20111129
18	GET_LONGTEXTS	Instance method	Public	Method		20070317
19	GET_NATIVE_QUEST_AS_HTML	Instance method	Private	Method		20070327
20	GET_QUESTIONNAIRE_AS_HTML	Instance method	Public	Method		20070315
21	GET_QUESTIONNAIRE_AS_PDF	Instance method	Public	Method		20070321
22	GET_RECIPIENTS_STATUS	Instance method	Public	Method		20070308
23	GET_RECIP_ATTR_MASS_DATA	Instance method	Public	Method		20070306
24	GET_RECIP_CUST_ATTR_MASS_DATA	Instance method	Public	Method		20070306
25	GET_SURVEYS	Static method	Public	Method		20070312
26	GET_SURVEY_STATUS	Instance method	Public	Method		20070321
27	READ_FOR_CHANGE	Static method	Public	Method		20070227
28	READ_FOR_DISPLAY	Static method	Public	Method		20070227
29	REMOVE_ACTIVE_QUESTIONNAIRE	Instance method	Public	Method		20070302
30	REMOVE_ALL_RECIPIENTS	Instance method	Public	Method		20070321
31	REMOVE_ATTRIBUTE	Instance method	Public	Method		20070302
32	REMOVE_GROUP	Instance method	Public	Method		20070302
33	REMOVE_NAMESPACE	Instance method	Private	Method		20070301
34	REMOVE_RECIPIENT	Instance method	Public	Method		20070302
35	REMOVE_RECIPIENT_ATTR	Instance method	Public	Method		20070321
36	REMOVE_RECIPIENT_CUST_ATTR	Instance method	Public	Method		20070321
37	SAVE	Instance method	Public	Method		20070226
38	SEND_SURVEY	Instance method	Public	Method		20070308
39	SET_ACTIVE_QUESTIONNAIRE	Instance method	Public	Method		20070301
40	SET_CONFIRMATION_PAGE	Instance method	Public	Method		20111129
41	SET_PARAMETER_ASSIGNMENT	Instance method	Public	Method		20070308
42	SET_RECIPIENT_STATUS	Instance method	Public	Method		20070310
43	SET_SURVEY_STATUS	Instance method	Public	Method		20070321

Events

Class CL_UWS_SURVEY_API has no event.

Types

Class CL_UWS_SURVEY_API has no local type.

Method Signatures

Method ADD_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_NAME	Call by reference	☑	Type reference (TYPE)	UWS_FULLNAME		Name of a Persistent Object	20070301
2	Importing	ID_RECIPIENT_ID	Call by reference	☑	Type reference (TYPE)	UXP_GUID		GUID	20070301
3	Importing	ID_TYPE	Call by reference	☑	Type reference (TYPE)	BU_PARTNER		Business Partner Number	20070301
4	Importing	ID_VALUE	Call by reference	☑	Type reference (TYPE)	XUBNAME		User Name in User Master Record	20070301

#	Exception	Resumable	Description	Created on
1	RECIPIENT_NOT_EXISTS	☐		20070301

Method ADD_GROUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ED_GROUP_ID	Value transfer	☐	Type reference (TYPE)	UXP_GUID		GUID	20070228
2	Importing	ID_GROUP_DESCRIPTION	Call by reference	☑	Type reference (TYPE)	UXP_DESCRIPTION		Name of a Persistent Object	20070228

Method ADD_GROUP on class CL_UWS_SURVEY_API has no exception.

Method ADD_HIER_NODE_MASS_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_DESCRIPTION	Call by reference	☑	Type reference (TYPE)	UXP_DESCRIPTION		Name of a Persistent Object	20070228

Method ADD_HIER_NODE_MASS_DATA on class CL_UWS_SURVEY_API has no exception.

Method ADD_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGE	Call by reference	☐	Type reference (TYPE)	UXB_T_MESSAGE		Error Messages	20080620
2	Importing	ID_MSGID	Call by reference	☐	Type reference (TYPE)	SYMSGID		Message Class	20080620
3	Importing	ID_MSGV1	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message Variable	20080620
4	Importing	ID_MSGV2	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message Variable	20080620
5	Importing	ID_MSGV3	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message Variable	20080620
6	Importing	ID_MSGV4	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message Variable	20080620
7	Importing	ID_NUMBER	Call by reference	☐	Type reference (TYPE)	SYMSGNO		Message Number	20080620
8	Importing	ID_TYPE	Call by reference	☐	Type reference (TYPE)	SYMSGTY		Message Type	20080620

Method ADD_MESSAGE on class CL_UWS_SURVEY_API has no exception.

Method ADD_RECIPIENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ED_RECIPIENT_ID	Value transfer	☐	Type reference (TYPE)	UXP_GUID		GUID	20070301
2	Importing	ID_BNAME	Call by reference	☑	Type reference (TYPE)	XUBNAME		User Name in User Master Record	20070228
3	Importing	ID_BPARTNER	Call by reference	☑	Type reference (TYPE)	BU_PARTNER		Business Partner Number	20070228
4	Importing	ID_EMAIL_ADDR	Call by reference	☑	Type reference (TYPE)	UWS_EMAIL_ADDR		E-Mail Address	20070228
5	Importing	ID_FULLNAME	Call by reference	☑	Type reference (TYPE)	UWS_FULLNAME		Name of a Persistent Object	20070228
6	Importing	ID_GROUP_ID	Call by reference	☑	Type reference (TYPE)	UXP_GUID		GUID	20070228
7	Importing	ID_LANGUAGE	Call by reference	☑	Type reference (TYPE)	LANGU		Language Key	20070228

#	Exception	Resumable	Description	Created on
1	GROUP_NOT_EXISTS	☐		20070301

Method ADD_RECIPIENTS_AS_MASS_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_RECIPIENTS	Call by reference	☐	Type reference (TYPE)	UWS_T_RECIPIENTS		Recipients	20070227

#	Exception	Resumable	Description	Created on
1	NO_MASS_DATA_NODE	☐		20070228
2	TARGET_HIERARCHY_ERROR	☐		20070227

Method ADD_RECIP_ATTR_MASS_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_RECIPIENT_ID	Call by reference	☐	Type reference (TYPE)	UXP_GUID		GUID	20070307
2	Importing	IT_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	UWS_T_SERVICE_PARAMETER		Service Parameter	20070307

Method ADD_RECIP_ATTR_MASS_DATA on class CL_UWS_SURVEY_API has no exception.

Method ADD_RECIP_CUST_ATTR_MASS_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_RECIPIENT_ID	Call by reference	☐	Type reference (TYPE)	UXP_GUID		GUID	20070307
2	Importing	IT_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	UWS_T_SERVICE_PARAMETER		Service Parameter	20070307

Method ADD_RECIP_CUST_ATTR_MASS_DATA on class CL_UWS_SURVEY_API has no exception.

Method ASSIGN_QUESTIONNAIRE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_APPLICATION	Call by reference	☑	Type reference (TYPE)	UXB_APPLICATION		Application	20080411
2	Importing	ID_GUID	Call by reference	☑	Type reference (TYPE)	UXP_GUID		GUID	20070302
3	Importing	ID_ID	Call by reference	☑	Type reference (TYPE)	UXP_ID		Object ID	20070302

#	Exception	Resumable	Description	Created on
1	QUESTIONNAIRE_NOT_FOUND	☐		20070302

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_APPLICATION	Call by reference	☐	Type reference (TYPE)	UXB_APPLICATION		Application	20070227
2	Importing	IR_SURVEY	Call by reference	☐	Object reference (TYPE REF TO)	CL_UWS_SURVEY		Persistant XML Object	20070227
3	Importing	IR_SURVEY_GROUP	Call by reference	☑	Object reference (TYPE REF TO)	CL_UWS_SURVEY_GROUP_API		Survey groups	20070319
4	Importing	IR_TARGET_HIERARCHY	Call by reference	☐	Object reference (TYPE REF TO)	CL_UWS_TARGET_HIERARCHY		UXP: Persistant Object (String Content)	20070228

Method CONSTRUCTOR on class CL_UWS_SURVEY_API has no exception.

Method CREATE_QUESTIONNAIRE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_QUESTIONNAIRE	Value transfer	☐	Object reference (TYPE REF TO)	CL_UWS_SURVEY_FORM		Survey Form Service	20070301
2	Importing	ID_APPLICATION	Call by reference	☑	Type reference (TYPE)	UXB_APPLICATION		Application	20080411
3	Importing	ID_GUID	Call by reference	☑	Type reference (TYPE)	UXP_GUID		GUID	20070301
4	Importing	ID_ID	Call by reference	☑	Type reference (TYPE)	UXB_ID		Object ID	20070301

#	Exception	Resumable	Description	Created on
1	QUESTIONNAIRE_NOT_FOUND	☐		20070301

Method CREATE_SURVEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_SURVEY	Value transfer	☐	Object reference (TYPE REF TO)	CL_UWS_SURVEY_API		Survey API	20070227
2	Importing	ID_APPLICATION	Call by reference	☐	Type reference (TYPE)	UXB_APPLICATION		Application	20070227
3	Importing	ID_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	UXP_DESCRIPTION		Name of a Persistent Object	20070227
4	Importing	ID_GROUP	Call by reference	☑	Type reference (TYPE)	UXP_GROUP		Group Id	20070227
5	Importing	ID_GUID	Call by reference	☑	Type reference (TYPE)	UXP_GUID		GUID	20070227
6	Importing	ID_ID	Call by reference	☐	Type reference (TYPE)	UXB_ID		Object ID	20070227

#	Exception	Resumable	Description	Created on
1	ASSIGNMENT_ALREADY_EXISTS	☐		20070318
2	ENQUEUE_SYSTEM_FAILURE	☐		20070227
3	GROUP_NOT_EXISTS	☐		20070318
4	ID_ALREADY_EXISTS	☐		20070316
5	PARAMETER_ERROR	☐		20070227

Method DELETE_SURVEY Signature

Method DELETE_SURVEY on class CL_UWS_SURVEY_API has no parameter.

#	Exception	Resumable	Description	Created on
1	NOT_DELETED	☐		20070315
2	NOT_POSSIBLE	☐		20070316

Method DESTROY Signature

Method DESTROY on class CL_UWS_SURVEY_API has no parameter.
Method DESTROY on class CL_UWS_SURVEY_API has no exception.

Method GET_ALL_QUESTIONNAIRES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_QUESTIONNAIRES	Value transfer	☐	Type reference (TYPE)	UXP_T_IE_KEY		List of questionnaires	20070315
2	Importing	ID_APPLICATION	Call by reference	☐	Type reference (TYPE)	UXB_APPLICATION		Application	20070315

Method GET_ALL_QUESTIONNAIRES on class CL_UWS_SURVEY_API has no exception.

Method GET_ASSIGNED_QUESTIONNAIRES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_ASSIGNED_QUESTIONNAIRES	Value transfer	☐	Type reference (TYPE)	UWS_T_ASSIGNED_QUESTIONNAIRES		Assigned Questionnaires	20070302

Method GET_ASSIGNED_QUESTIONNAIRES on class CL_UWS_SURVEY_API has no exception.

Method GET_CONFIRMATION_PAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ED_CONF_PAGE	Value transfer	☐	Type reference (TYPE)	UXB_FLAG		'X'- > Conf. Page / ' '-> No Conf. Page	20111129

Method GET_CONFIRMATION_PAGE on class CL_UWS_SURVEY_API has no exception.

Method GET_LONGTEXTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_LONGTEXTS	Value transfer	☐	Type reference (TYPE)	UWS_T_BW_WS_LONGTEXTS		BW Interface: Question Texts	20070317
2	Importing	ID_LANGUAGE	Call by reference	☐	Type reference (TYPE)	LANGU		Language Key	20070317
3	Importing	IT_RECIPIENTS	Call by reference	☐	Type reference (TYPE)	UXP_T_GUID		Table of GUIDs	20070317

#	Exception	Resumable	Description	Created on
1	NO_ACTIVE_QUESTIONNAIRE	☐		20070317

Method GET_NATIVE_QUEST_AS_HTML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ED_HTML	Value transfer	☐	Type reference (TYPE)	STRING			20070327
2	Importing	ID_PUBLISHING_MODE	Call by reference	☐	Type reference (TYPE)	UWSP_PUBLISHING_MODE	CL_UWS_PUBLISHING=>CD_MODE_HTML_MAIL	Publishing Mode	20070327
3	Importing	IR_SURVEY_FORM	Call by reference	☐	Object reference (TYPE REF TO)	CL_UWS_SURVEY_FORM		Survey Form Service	20070327

Method GET_NATIVE_QUEST_AS_HTML on class CL_UWS_SURVEY_API has no exception.

Method GET_QUESTIONNAIRE_AS_HTML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ED_HTML	Value transfer	☐	Type reference (TYPE)	STRING			20070315
2	Importing	ID_RECIPIENT	Call by reference	☑	Type reference (TYPE)	UXP_GUID		GUID	20070315

#	Exception	Resumable	Description	Created on
1	NOT_SEND	☐		20070315
2	NO_ACTIVE_QUESTIONNAIRE	☐		20070315

Method GET_QUESTIONNAIRE_AS_PDF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ED_PDF	Value transfer	☐	Type reference (TYPE)	XSTRING			20070321
2	Importing	ID_RECIPIENT	Call by reference	☑	Type reference (TYPE)	UXP_GUID		GUID	20070321

#	Exception	Resumable	Description	Created on
1	NOT_SEND	☐		20070321
2	NO_ACTIVE_QUESTIONNAIRE	☐		20070321

Method GET_RECIPIENTS_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_RECIPIENTS_STATUS	Value transfer	☐	Type reference (TYPE)	UWS_T_RECIPIENTS_STATUS		Recipients status	20070309
2	Importing	IT_RECIPIENTS	Call by reference	☐	Type reference (TYPE)	UXP_T_GUID		Table of GUIDs	20070309

#	Exception	Resumable	Description	Created on
1	NOT_FOUND	☐		20070309
2	NO_ACTIVE_QUESTIONNAIRE	☐		20070314

Method GET_RECIP_ATTR_MASS_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_ATTRIBUTES	Value transfer	☐	Type reference (TYPE)	UWS_T_SERVICE_PARAMETER		Service Parameter	20070306
2	Importing	ID_RECIPIENT_ID	Call by reference	☐	Type reference (TYPE)	UXP_GUID		GUID	20070306

Method GET_RECIP_ATTR_MASS_DATA on class CL_UWS_SURVEY_API has no exception.

Method GET_RECIP_CUST_ATTR_MASS_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_ATTRIBUTES	Value transfer	☐	Type reference (TYPE)	UWS_T_SERVICE_PARAMETER		Service Parameter	20070306
2	Importing	ID_RECIPIENT_ID	Call by reference	☐	Type reference (TYPE)	UXP_GUID		GUID	20070306

Method GET_RECIP_CUST_ATTR_MASS_DATA on class CL_UWS_SURVEY_API has no exception.

Method GET_SURVEYS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ET_SURVEYS	Value transfer	☐	Type reference (TYPE)	UWS_T_SURVEYS		List of surveys	20070312
2	Importing	ID_APPLICATION	Call by reference	☐	Type reference (TYPE)	UXB_APPLICATION		Application	20070312
3	Importing	ID_GROUP	Call by reference	☑	Type reference (TYPE)	UXP_GROUP		Group Id	20070312

Method GET_SURVEYS on class CL_UWS_SURVEY_API has no exception.

Method GET_SURVEY_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ED_STATUS	Value transfer	☐	Type reference (TYPE)	UWS_SURVEY_STATUS		Status of a Survey	20070321

Method GET_SURVEY_STATUS on class CL_UWS_SURVEY_API has no exception.

Method READ_FOR_CHANGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_SURVEY	Value transfer	☐	Object reference (TYPE REF TO)	CL_UWS_SURVEY_API		Survey API	20070227
2	Importing	ID_APPLICATION	Call by reference	☐	Type reference (TYPE)	UXB_APPLICATION		Application	20070227
3	Importing	ID_GUID	Call by reference	☑	Type reference (TYPE)	UXP_GUID		GUID	20070227
4	Importing	ID_ID	Call by reference	☑	Type reference (TYPE)	UXB_ID		Object ID	20070227
5	Importing	ID_VERSION	Call by reference	☐	Type reference (TYPE)	UXP_VERSION	'1'	Version	20070227

#	Exception	Resumable	Description	Created on
1	ENQUEUE_FAILED	☐		20070322
2	NOT_FOUND	☐		20070227

Method READ_FOR_DISPLAY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ER_SURVEY	Value transfer	☐	Object reference (TYPE REF TO)	CL_UWS_SURVEY_API		Survey API	20070227
2	Importing	ID_APPLICATION	Call by reference	☐	Type reference (TYPE)	UXB_APPLICATION		Application	20070227
3	Importing	ID_GUID	Call by reference	☑	Type reference (TYPE)	UXP_GUID		GUID	20070227
4	Importing	ID_ID	Call by reference	☑	Type reference (TYPE)	UXB_ID		Object ID	20070227
5	Importing	ID_VERSION	Call by reference	☐	Type reference (TYPE)	UXP_VERSION	'1'	Version	20070227

#	Exception	Resumable	Description	Created on
1	NOT_FOUND	☐		20070227

Method REMOVE_ACTIVE_QUESTIONNAIRE Signature

Method REMOVE_ACTIVE_QUESTIONNAIRE on class CL_UWS_SURVEY_API has no parameter.
Method REMOVE_ACTIVE_QUESTIONNAIRE on class CL_UWS_SURVEY_API has no exception.

Method REMOVE_ALL_RECIPIENTS Signature

Method REMOVE_ALL_RECIPIENTS on class CL_UWS_SURVEY_API has no parameter.

#	Exception	Resumable	Description	Created on
1	ERROR	☐		20070321

Method REMOVE_ATTRIBUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_NAME	Call by reference	☑	Type reference (TYPE)	UWS_FULLNAME		Name of a Persistent Object	20070302
2	Importing	ID_RECIPIENT_ID	Call by reference	☑	Type reference (TYPE)	UXP_GUID		GUID	20070302

#	Exception	Resumable	Description	Created on
1	RECIPIENT_NOT_EXISTS	☐		20070302

Method REMOVE_GROUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_GROUP_ID	Call by reference	☐	Type reference (TYPE)	UXP_GUID		GUID	20070306

#	Exception	Resumable	Description	Created on
1	GROUP_NOT_EXISTS	☐		20070306

Method REMOVE_NAMESPACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_ELEMENT		IF_IXML_NODE	20070301
2	Importing	IR_PARENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_IXML_NODE		IF_IXML_NODE	20070301

Method REMOVE_NAMESPACE on class CL_UWS_SURVEY_API has no exception.

Method REMOVE_RECIPIENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_RECIPIENT_ID	Call by reference	☐	Type reference (TYPE)	UXP_GUID		GUID	20070306

#	Exception	Resumable	Description	Created on
1	RECIPIENT_NOT_EXISTS	☐		20070306

Method REMOVE_RECIPIENT_ATTR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_RECIPIENT_ID	Call by reference	☐	Type reference (TYPE)	UXP_GUID		GUID	20070321
2	Importing	IT_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	UWS_T_SERVICE_PARAMETER		Service Parameter	20070321

Method REMOVE_RECIPIENT_ATTR on class CL_UWS_SURVEY_API has no exception.

Method REMOVE_RECIPIENT_CUST_ATTR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_RECIPIENT_ID	Call by reference	☐	Type reference (TYPE)	UXP_GUID		GUID	20070321
2	Importing	IT_ATTRIBUTES	Call by reference	☐	Type reference (TYPE)	UWS_T_SERVICE_PARAMETER		Service Parameter	20070321

Method REMOVE_RECIPIENT_CUST_ATTR on class CL_UWS_SURVEY_API has no exception.

Method SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGE	Call by reference	☐	Type reference (TYPE)	UXB_T_MESSAGE		Error Messages	20080620
2	Importing	ID_COMMIT_WORK	Call by reference	☐	Type reference (TYPE)	UXB_FLAG		Indicator (X or Space)	20070226

Method SAVE on class CL_UWS_SURVEY_API has no exception.

Method SEND_SURVEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGE	Call by reference	☐	Type reference (TYPE)	UXB_T_MESSAGE		Error Messages	20070308
2	Exporting	ET_RECEIVER	Value transfer	☐	Type reference (TYPE)	UWSP_T_RECEIVER_T_PARAMETER		Recipient and Recipient-Dependent Parameter	20070308
3	Importing	ID_ANSWER_TYPE	Value transfer	☑	Type reference (TYPE)	STRING		Answer type - PDF or XML	20070622
4	Importing	ID_BACKGROUND	Call by reference	☑	Type reference (TYPE)	STRING		MIME repository object URL	20070622
5	Importing	ID_COMMIT_WORK	Call by reference	☐	Type reference (TYPE)	UXB_FLAG	ABAP_TRUE	Indicator (X or Space)	20070321
6	Importing	ID_MAIL_BODY	Call by reference	☑	Type reference (TYPE)	STRING			20070308
7	Importing	ID_MAIL_HEADER	Call by reference	☐	Type reference (TYPE)	STRING			20070308
8	Importing	ID_PUBLISHING_MODE	Call by reference	☐	Type reference (TYPE)	STRING	'MAIL'		20070308
9	Importing	ID_QUESTIONNAIRE_TYPE	Call by reference	☐	Type reference (TYPE)	UXP_QUESTIONNAIRE_TYPE	'HTML'	Questionnaire type	20070308
10	Importing	IT_ATTACHMENTS	Call by reference	☑	Type reference (TYPE)	UWSP_T_ATTACHMENTS		Table of attachments	20070315
11	Importing	IT_RECEIVER	Call by reference	☑	Type reference (TYPE)	UXP_T_GUID		Table of GUIDs	20070308

#	Exception	Resumable	Description	Created on
1	NO_ACTIVE_QUESTIONNAIRE	☐		20070308
2	NO_MAIL_BODY	☐		20070308
3	NO_MAIL_CUSTOMIZING	☐		20070308
4	NO_MAIL_HEADER	☐		20070308

Method SET_ACTIVE_QUESTIONNAIRE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_APPLICATION	Call by reference	☑	Type reference (TYPE)	UXB_APPLICATION		Application	20080411
2	Importing	ID_GUID	Call by reference	☑	Type reference (TYPE)	UXP_GUID		GUID	20070301
3	Importing	ID_ID	Call by reference	☑	Type reference (TYPE)	UXP_ID		Object ID	20070301

#	Exception	Resumable	Description	Created on
1	QUESTIONNAIRE_NOT_FOUND	☐		20070301

Method SET_CONFIRMATION_PAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_CONF_PAGE	Call by reference	☐	Type reference (TYPE)	UXB_FLAG		'X'- > Conf. Page / ' '-> No Conf. Page	20111129

Method SET_CONFIRMATION_PAGE on class CL_UWS_SURVEY_API has no exception.

Method SET_PARAMETER_ASSIGNMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_PARAM_ASSIGNMENT	Call by reference	☐	Type reference (TYPE)	UWS_T_PARAM_ASSIGNMENT			20070308

#	Exception	Resumable	Description	Created on
1	NOT_FOUND	☐		20070308

Method SET_RECIPIENT_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_RECIPIENT_ID	Call by reference	☐	Type reference (TYPE)	UXP_GUID		GUID	20070310
2	Importing	ID_STATUS	Call by reference	☐	Type reference (TYPE)	UWS_SF_STATUS		Send Status of a Questionnaire	20070310

#	Exception	Resumable	Description	Created on
1	FAILED	☐		20070310
2	NOT_FOUND	☐		20070310
3	QUESTIONNAIRE_NOT_FOUND	☐		20070310

Method SET_SURVEY_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID_STATUS	Call by reference	☐	Type reference (TYPE)	UWS_SURVEY_STATUS		Status of a Survey	20070321

Method SET_SURVEY_STATUS on class CL_UWS_SURVEY_API has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in