SAP ABAP Interface IF_UWS_SURVEY_FORM_API (Survey Form API)

Hierarchy

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

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_UWS_SURVEY_FORM_API	Survey Form API	20070528

Properties

Interface	IF_UWS_SURVEY_FORM_API
Short Description	Survey Form API

General Data

Package	UWS_SURVEY_FORM	Form-Based Web Services: Questionnaires
Created	20070528	SAP
Last changed	20090618	SAP
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)

Interfaces

Interface IF_UWS_SURVEY_FORM_API has no interface.

Friends

Interface IF_UWS_SURVEY_FORM_API has no friend.

Attributes

Interface IF_UWS_SURVEY_FORM_API has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_ELEMENT	Instance method	Public	Method	Add new Questionnaire Element to Hierarchy	20070528
2	COPY_QUESTIONNAIRE	Instance method	Public	Method	Copy current Questionnaire	20070529
3	CREATE_QUESTIONNAIRE	Static method	Public	Method	Create new Questionnaire	20070528
4	DELETE_QUESTIONNAIRE	Instance method	Public	Method	Delete current Questionnaire	20070528
5	GET_ALLOWED_SUBELEMENTS	Instance method	Public	Method	Get the list of allowed subelement types	20070530
6	GET_ELEMENT_CHILDREN	Instance method	Public	Method	Get Element Children	20070531
7	GET_ELEMENT_DATA	Instance method	Public	Method	Get element data	20070528
8	GET_MASTER_LANGUAGE	Instance method	Public	Method	Return the language in which Questionnaire was created	20070704
9	GET_QUESTIONNAIRES	Static method	Public	Method	Return the list of Questionnaires for the given application	20070528
10	GET_QUESTIONNAIRE_DATA	Instance method	Public	Method	Get Questionnaire Header Data	20070528
11	GET_ROOT_ELEMENT	Instance method	Public	Method	Get root Element of Hierarchy	20070530
12	GET_TEXT	Instance method	Public	Method	Read Questionnaire Text for the given Text ID and Language	20070704
13	GET_TEXTS	Instance method	Public	Method	Read all Questionnaire Texts for the given Language	20070704
14	GET_TEXT_ID_LIST	Instance method	Public	Method	Return a table of Texts Identifiers for the Questionnaire	20070704
15	READ_FOR_CHANGE	Static method	Public	Method	Read Questionnaire for Change	20070528
16	READ_FOR_DISPLAY	Static method	Public	Method	Read Questionnaire for Display	20070528
17	REMOVE_ELEMENT	Instance method	Public	Method	Remove element	20070528
18	SAVE_QUESTIONNAIRE	Instance method	Public	Method	Save current Questionnaire	20070528
19	SET_ELEMENT_DATA	Instance method	Public	Method	Set element data	20070528
20	SET_QUESTIONNAIRE_DATA	Instance method	Public	Method	Set Questionnaire Header Data	20070528
21	SET_TEXT	Instance method	Public	Method	Save Questionnaire Text for the given Text ID and Language	20070704
22	SET_TEXTS	Instance method	Public	Method	Save all Questionnaire Texts for the given Language	20070704
23	VALIDATE_QUESTIONNAIRE	Instance method	Public	Method	Questionnaire validation	20070605

Events

Interface IF_UWS_SURVEY_FORM_API has no event.

Types

Interface IF_UWS_SURVEY_FORM_API has no local type.

Method Signatures

Method ADD_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ELEMENT_TYPE	Call by reference	☐	Type reference (TYPE)	UWS_ELEMENT_TYPE		Questionnaire Element Type	20070531
2	Importing	IV_PARENT_ELEMENT_KEY	Call by reference	☐	Type reference (TYPE)	UWS_ELEMENT_KEY		Questionnaire Element Key (Hierarchy)	20070531
3	Returning	RV_NEW_ELEMENT_KEY	Value transfer	☐	Type reference (TYPE)	UWS_ELEMENT_KEY		Questionnaire Element Key (Hierarchy)	20070531

#	Exception	Resumable	Description	Created on
1	CX_UWS_QUE_EDIT_ERROR	☐	Edit errors	20070622

Method COPY_QUESTIONNAIRE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_QUESTIONNAIRE	Call by reference	☐	Object reference (TYPE REF TO)	IF_UWS_SURVEY_FORM_API		Survey Form API	20070529
2	Importing	IV_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	UXP_DESCRIPTION		Name of a Persistent Object	20070529
3	Importing	IV_GUID	Call by reference	☐	Type reference (TYPE)	UXP_GUID		GUID	20070529
4	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	UXB_ID		Object ID	20070529

#	Exception	Resumable	Description	Created on
1	CX_UWS_QUE_CREATE_ERROR	☐	Questionnaire create errors	20070622
2	CX_UWS_QUE_EDIT_ERROR	☐	Edit errors	20070622

Method CREATE_QUESTIONNAIRE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_QUESTIONNAIRE	Call by reference	☐	Object reference (TYPE REF TO)	IF_UWS_SURVEY_FORM_API		Survey Form API	20070528
2	Importing	IV_APPLICATION	Call by reference	☐	Type reference (TYPE)	UXB_APPLICATION		Application	20070528
3	Importing	IV_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	UXP_DESCRIPTION		Name of a Persistent Object	20070528
4	Importing	IV_GUID	Call by reference	☐	Type reference (TYPE)	UXP_GUID		GUID	20070528
5	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	UXB_ID		Object ID	20070528

#	Exception	Resumable	Description	Created on
1	CX_UWS_QUE_CREATE_ERROR	☐	Questionnaire create errors	20070621

Method DELETE_QUESTIONNAIRE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMMIT_WORK	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		commit work	20070621

#	Exception	Resumable	Description	Created on
1	CX_UWS_QUE_DELETE_ERROR	☐	Questionnaire delete errors	20070621

Method GET_ALLOWED_SUBELEMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ALLOWED_SUBELEMENT_TYPES	Call by reference	☐	Type reference (TYPE)	UWS_T_ELEMENT_TYPE		Table of Questionnaire Element Types	20070530
2	Importing	IV_PARENT_ELEMENT_TYPE	Call by reference	☐	Type reference (TYPE)	UWS_ELEMENT_TYPE		Questionnaire Element Type	20070530

Method GET_ALLOWED_SUBELEMENTS on Interface IF_UWS_SURVEY_FORM_API has no exception.

Method GET_ELEMENT_CHILDREN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SUBELEMENT_KEYS	Call by reference	☐	Type reference (TYPE)	UWS_T_ELEMENT_KEY		Table of Questionnaire Element Keys	20070531
2	Importing	IV_ELEMENT_KEY	Call by reference	☐	Type reference (TYPE)	UWS_ELEMENT_KEY		Questionnaire Element Type	20070531

#	Exception	Resumable	Description	Created on
1	CX_UWS_QUE_EDIT_ERROR	☐	Edit errors	20070622

Method GET_ELEMENT_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ELEMENT_DATA	Call by reference	☐	Type reference (TYPE)	UWS_T_SERVICE_PARAMETER		Service Parameter	20070530
2	Exporting	EV_ELEMENT_TYPE	Call by reference	☐	Type reference (TYPE)	UWS_ELEMENT_TYPE		Questionnaire Element Type	20070615
3	Importing	IV_ELEMENT_KEY	Call by reference	☐	Type reference (TYPE)	UWS_ELEMENT_KEY		Questionnaire Element Key (Hierarchy)	20070530

#	Exception	Resumable	Description	Created on
1	CX_UWS_QUE_EDIT_ERROR	☐	Edit errors	20070622

Method GET_MASTER_LANGUAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_MASTER_LANG	Call by reference	☐	Type reference (TYPE)	LANG		Language ID	20070704

Method GET_MASTER_LANGUAGE on Interface IF_UWS_SURVEY_FORM_API has no exception.

Method GET_QUESTIONNAIRES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QUESTIONNAIRES	Call by reference	☐	Type reference (TYPE)	UXP_T_IE_KEY		List of Questionnaires	20070528
2	Importing	IV_APPLICATION	Call by reference	☐	Type reference (TYPE)	UXB_APPLICATION		Application	20070528

Method GET_QUESTIONNAIRES on Interface IF_UWS_SURVEY_FORM_API has no exception.

Method GET_QUESTIONNAIRE_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CHANGEABILITY	Call by reference	☐	Type reference (TYPE)	UWS_CHANGEABILITY		Survey Changeable after Sending	20070528
2	Exporting	EV_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	UXP_DESCRIPTION		Name of a Persistent Object	20070528
3	Exporting	EV_ID	Call by reference	☐	Type reference (TYPE)	UXB_ID		Object ID	20070528
4	Exporting	EV_POSTING_TYPE	Call by reference	☐	Type reference (TYPE)	UWS_POSTING_TYPE		Update Type of Survey	20070528

Method GET_QUESTIONNAIRE_DATA on Interface IF_UWS_SURVEY_FORM_API has no exception.

Method GET_ROOT_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_ELEMENT_KEY	Value transfer	☐	Type reference (TYPE)	UWS_ELEMENT_KEY		Questionnaire Element Key (Hierarchy)	20070530

Method GET_ROOT_ELEMENT on Interface IF_UWS_SURVEY_FORM_API has no exception.

Method GET_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20070704
2	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	LANG		Language ID	20070704
3	Importing	IV_TEXT_ID	Call by reference	☐	Type reference (TYPE)	UWS_QUE_TEXT_ID		Questionnaire Text Identifier	20070704

#	Exception	Resumable	Description	Created on
1	CX_UWS_QUE_EDIT_ERROR	☐	Edit errors	20070706

Method GET_TEXTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_TEXT_LIST	Call by reference	☐	Type reference (TYPE)	UWS_T_QUE_TEXT		Table of Questionnaire Texts with Identifiers	20070704
2	Importing	IT_TEXT_ID_LIST	Call by reference	☐	Type reference (TYPE)	UWS_T_QUE_TEXT_ID		Table of Questionnaire Text Identifier	20070704
3	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	LANG		Language ID	20070704

#	Exception	Resumable	Description	Created on
1	CX_UWS_QUE_EDIT_ERROR	☐	Edit errors	20070706

Method GET_TEXT_ID_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_TEXT_ID_LIST	Call by reference	☐	Type reference (TYPE)	UWS_T_QUE_TEXT_ID		Table of Questionnaire Text Identifier	20070704

Method GET_TEXT_ID_LIST on Interface IF_UWS_SURVEY_FORM_API has no exception.

Method READ_FOR_CHANGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_QUESTIONNAIRE	Call by reference	☐	Object reference (TYPE REF TO)	IF_UWS_SURVEY_FORM_API		Survey Form API	20070528
2	Importing	IV_APPLICATION	Call by reference	☐	Type reference (TYPE)	UXB_APPLICATION		Application	20070528
3	Importing	IV_GUID	Call by reference	☐	Type reference (TYPE)	UXP_GUID		GUID	20070528
4	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	UXB_ID		Object ID	20070528
5	Importing	IV_VERSION	Call by reference	☐	Type reference (TYPE)	UXP_VERSION		Version	20070528

#	Exception	Resumable	Description	Created on
1	CX_UWS_QUE_READ_ERROR	☐	Quesionnaire read errors	20070621

Method READ_FOR_DISPLAY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_QUESTIONNAIRE	Call by reference	☐	Object reference (TYPE REF TO)	IF_UWS_SURVEY_FORM_API		Survey Form API	20070528
2	Importing	IV_APPLICATION	Call by reference	☐	Type reference (TYPE)	UXB_APPLICATION		Application	20070528
3	Importing	IV_GUID	Call by reference	☐	Type reference (TYPE)	UXP_GUID		GUID	20070528
4	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	UXB_ID		Object ID	20070528
5	Importing	IV_VERSION	Call by reference	☐	Type reference (TYPE)	UXP_VERSION		Version	20070528

#	Exception	Resumable	Description	Created on
1	CX_UWS_QUE_READ_ERROR	☐	Quesionnaire read errors	20070621

Method REMOVE_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ELEMENT_KEY	Call by reference	☐	Type reference (TYPE)	UWS_ELEMENT_KEY		Questionnaire Element Key (Hierarchy)	20070529

#	Exception	Resumable	Description	Created on
1	CX_UWS_QUE_EDIT_ERROR	☐	Edit errors	20070622

Method SAVE_QUESTIONNAIRE 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	IV_COMMIT_WORK	Call by reference	☐	Type reference (TYPE)	UXB_FLAG		Indicator (X or Space)	20070528

#	Exception	Resumable	Description	Created on
1	CX_UWS_QUE_EDIT_ERROR	☐	Edit errors	20070706
2	CX_UWS_QUE_SAVE_ERROR	☐	Questionnaire save errors	20070621

Method SET_ELEMENT_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ELEMENT_DATA	Call by reference	☐	Type reference (TYPE)	UWS_T_SERVICE_PARAMETER		Service Parameter	20070530
2	Importing	IV_ELEMENT_KEY	Call by reference	☐	Type reference (TYPE)	UWS_ELEMENT_KEY		Questionnaire Element Key (Hierarchy)	20070530

#	Exception	Resumable	Description	Created on
1	CX_UWS_QUE_EDIT_ERROR	☐	Edit errors	20070706

Method SET_QUESTIONNAIRE_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CHANGEABILITY	Call by reference	☑	Type reference (TYPE)	UWS_CHANGEABILITY		Survey Changeable after Sending	20070528
2	Importing	IV_DESCRIPTION	Call by reference	☑	Type reference (TYPE)	UXP_DESCRIPTION		Name of a Persistent Object	20070528
3	Importing	IV_ID	Call by reference	☑	Type reference (TYPE)	UXB_ID		Object ID	20070528
4	Importing	IV_POSTING_TYPE	Call by reference	☑	Type reference (TYPE)	UWS_POSTING_TYPE		Update Type of Survey	20070528

Method SET_QUESTIONNAIRE_DATA on Interface IF_UWS_SURVEY_FORM_API has no exception.

Method SET_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	LANG		Language ID	20070704
2	Importing	IV_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20070704
3	Importing	IV_TEXT_ID	Call by reference	☐	Type reference (TYPE)	UWS_QUE_TEXT_ID		Questionnaire Text Identifier	20070704

#	Exception	Resumable	Description	Created on
1	CX_UWS_QUE_EDIT_ERROR	☐	Edit errors	20070706

Method SET_TEXTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_QUE_TEXT_LIST	Call by reference	☐	Type reference (TYPE)	UWS_T_QUE_TEXT		Table of Questionnaire Texts with Identifiers	20070704
2	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	LANG		Language ID	20070704

#	Exception	Resumable	Description	Created on
1	CX_UWS_QUE_EDIT_ERROR	☐	Edit errors	20070706

Method VALIDATE_QUESTIONNAIRE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_RESULT	Value transfer	☐	Type reference (TYPE)	BAPIRET1		Return Parameter	20070605

Method VALIDATE_QUESTIONNAIRE on Interface IF_UWS_SURVEY_FORM_API has no exception.

History

Last changed by/on	SAP	20090618
SAP Release Created in	700