SAP ABAP Class CL_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 - Using

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

Properties

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

General Data

Message Class
Program status
Category	0
Package	UWS_SURVEY_FORM	Form-Based Web Services: Questionnaires
Created	20070528	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)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_UWS_SURVEY_FORM_API	☐	☐	Survey Form API	20070528

Friends

Class CL_UWS_SURVEY_FORM_API has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MC_ATTRIBUTE_ELEM_COUNT	Constant	Private	☐	Type reference (TYPE)	STRING	'elementcnt'		20070607
2	MC_DOCUMENT_CLASS	Constant	Private	☐	Type reference (TYPE)	DOKU_ID	'TX'	Document class for QUE Texts	20070705
3	MC_ID_ALLOWED_CHARS	Constant	Private	☐	Type reference (TYPE)	STRING	'_0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'	Allowed chars for ID	20070705
4	MO_QUESTIONNAIRE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_IXML_DOCUMENT		IF_IXML_DOCUMENT	20070604
5	MO_SURVEY_FORM	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_UWS_SURVEY_FORM		Survey Form Service	20070528
6	MT_QUE_TEXTS	Instance attribute	Private	☐	Type reference (TYPE)	T_QUE_TEXTS_INTERNAL		Buffer for internationalized Texts	20070705
7	MV_APPLICATION	Instance attribute	Private	☐	Type reference (TYPE)	UXB_APPLICATION		Application	20070528

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_MESSAGE	Instance method	Private	Method		20080620
2	CHECK_DELETABLE	Instance method	Private	Method	Check if Element is allowed to be deleted	20070613
3	CHECK_FLOATING_TYPE	Instance method	Private	Method	Check if input value is a number with floating point	20070705
4	CHECK_INSERTABLE	Instance method	Private	Method	Check if Element is allowed to be Inserted as Child	20070531
5	CHECK_N_POST_QUE_LANG_TEXTS	Instance method	Private	Method	Posts unchanged Questionnaire Texts in all Languanges to DB	20070904
6	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20070528
7	CREATE_NEW_NODE_BSP	Instance method	Private	Method	Create new Layout Element	20070609
8	CREATE_NEW_NODE_QUE	Instance method	Private	Method	Create new Questionnaire Element	20070608
9	GET_ELEMENT_COUNT	Instance method	Private	Method	Get Number of Elements in Questionnaire	20070607
10	GET_ELEMENT_NS_DATA	Instance method	Private	Method	Get Namespace Data for given Element Type	20070624
11	GET_NODE_BY_ELEMENT_KEY	Instance method	Private	Method	Obtain XML Node by given Element Key	20070530
12	INITIALIZE	Instance method	Private	Method	Initialize internal layout representation	20070604
13	IS_ATTRIBUTE_INTERNAL	Instance method	Private	Method	Check if node attribute is internal	20070607
14	IS_ELEMENT_ID_UNIQUE	Instance method	Private	Method	Check if element id is unique	20070613
15	PROCESS_ELEMENTS	Instance method	Private	Method	Process elements (recursive traversal)	20070615
16	READ_ALL_QUE_LANG_TEXTS	Instance method	Private	Method	Read All Questionnaire Texts in all Languages to Buffer	20070705
17	SET_ELEMENT_COUNT	Instance method	Private	Method	Set Number of Elements in Questionnaire	20070607
18	UPDATE_SURVEY_LAYOUT_FROM_QUE	Instance method	Private	Method	Update survey form layout component from internal DOM	20070607
19	VALIDATE_ELMNT_ATTR	Instance method	Private	Method	Validate element attributes	20070618

Events

Class CL_UWS_SURVEY_FORM_API has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	QUE_TEXTS_INTERNAL	Protected	See coding			20070705	BEGIN OF que_texts_internal, id_int TYPE tuxs_quest_trans-identifier, langu TYPE lang, id_ext TYPE tdobname, text TYPE string, END OF que_texts_internal
2	T_QUE_TEXTS_INTERNAL	Protected	See coding			20070705	t_que_texts_internal TYPE SORTED TABLE OF que_texts_internal WITH UNIQUE KEY id_int langu

Method Signatures

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_FORM_API has no exception.

Method CHECK_DELETABLE 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)	20070613
2	Returning	RV_DELETABLE	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20070613

Method CHECK_DELETABLE on class CL_UWS_SURVEY_FORM_API has no exception.

Method CHECK_FLOATING_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	STRING		Checked value	20070705
2	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Result	20070705

Method CHECK_FLOATING_TYPE on class CL_UWS_SURVEY_FORM_API has no exception.

Method CHECK_INSERTABLE 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_TYPE	Call by reference	☐	Type reference (TYPE)	UWS_ELEMENT_TYPE		Questionnaire Element Type	20070531
3	Returning	RV_INSERTABLE	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20070531

Method CHECK_INSERTABLE on class CL_UWS_SURVEY_FORM_API has no exception.

Method CHECK_N_POST_QUE_LANG_TEXTS Signature

Method CHECK_N_POST_QUE_LANG_TEXTS on class CL_UWS_SURVEY_FORM_API has no parameter.

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

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SURVEY_FORM	Call by reference	☐	Object reference (TYPE REF TO)	CL_UWS_SURVEY_FORM		Survey Form Service	20070528
2	Importing	IV_APPLICATION	Call by reference	☐	Type reference (TYPE)	UXB_APPLICATION		Application	20070528

Method CONSTRUCTOR on class CL_UWS_SURVEY_FORM_API has no exception.

Method CREATE_NEW_NODE_BSP 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	20070609
2	Returning	RO_NODE	Value transfer	☐	Object reference (TYPE REF TO)	IF_IXML_NODE		IF_IXML_NODE	20070609

Method CREATE_NEW_NODE_BSP on class CL_UWS_SURVEY_FORM_API has no exception.

Method CREATE_NEW_NODE_QUE 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	20070608
2	Returning	RO_NODE	Value transfer	☐	Object reference (TYPE REF TO)	IF_IXML_NODE		IF_IXML_NODE	20070608

Method CREATE_NEW_NODE_QUE on class CL_UWS_SURVEY_FORM_API has no exception.

Method GET_ELEMENT_COUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_ELEM_COUNT	Value transfer	☐	Type reference (TYPE)	I		Returning element count	20070607

Method GET_ELEMENT_COUNT on class CL_UWS_SURVEY_FORM_API has no exception.

Method GET_ELEMENT_NS_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_NAMESPACE_PREFIX	Call by reference	☐	Type reference (TYPE)	STRING			20070624
2	Exporting	EV_NAMESPACE_URI	Call by reference	☐	Type reference (TYPE)	STRING			20070624
3	Importing	IV_ELEMENT_TYPE	Call by reference	☐	Type reference (TYPE)	UWS_ELEMENT_TYPE		Questionnaire Element Type	20070624

Method GET_ELEMENT_NS_DATA on class CL_UWS_SURVEY_FORM_API has no exception.

Method GET_NODE_BY_ELEMENT_KEY 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 Type	20070530
2	Returning	RO_NODE	Value transfer	☐	Object reference (TYPE REF TO)	IF_IXML_NODE		IF_IXML_NODE	20070530

Method GET_NODE_BY_ELEMENT_KEY on class CL_UWS_SURVEY_FORM_API has no exception.

Method INITIALIZE Signature

Method INITIALIZE on class CL_UWS_SURVEY_FORM_API has no parameter.
Method INITIALIZE on class CL_UWS_SURVEY_FORM_API has no exception.

Method IS_ATTRIBUTE_INTERNAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ATTRIBUTE_NAME	Call by reference	☐	Type reference (TYPE)	UWS_SERVICE_PARAMETER_NAME		Name of attribute	20070614
2	Returning	RV_INTERNAL	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20070614

Method IS_ATTRIBUTE_INTERNAL on class CL_UWS_SURVEY_FORM_API has no exception.

Method IS_ELEMENT_ID_UNIQUE 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	20070624
2	Importing	IV_KEY_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Checked Key name	20070613
3	Importing	IV_KEY_VALUE	Call by reference	☐	Type reference (TYPE)	STRING		Checked key value	20070613
4	Returning	RV_IS_UNIQUE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Result	20070613

Method IS_ELEMENT_ID_UNIQUE on class CL_UWS_SURVEY_FORM_API has no exception.

Method PROCESS_ELEMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_KEY_FROM	Call by reference	☐	Type reference (TYPE)	UWS_ELEMENT_KEY		Questionnaire Element Key (Hierarchy)	20070615
2	Importing	IV_NEW_QUEST	Call by reference	☐	Object reference (TYPE REF TO)	IF_UWS_SURVEY_FORM_API		New questionnaire	20070615
3	Importing	IV_PARENT_KEY_WHERE	Call by reference	☐	Type reference (TYPE)	UWS_ELEMENT_KEY		Questionnaire Element Key (Hierarchy)	20070615

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

Method READ_ALL_QUE_LANG_TEXTS Signature

Method READ_ALL_QUE_LANG_TEXTS on class CL_UWS_SURVEY_FORM_API has no parameter.

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

Method SET_ELEMENT_COUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ELEM_COUNT	Call by reference	☐	Type reference (TYPE)	I		Element Count	20070607

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

Method UPDATE_SURVEY_LAYOUT_FROM_QUE Signature

Method UPDATE_SURVEY_LAYOUT_FROM_QUE on class CL_UWS_SURVEY_FORM_API has no parameter.
Method UPDATE_SURVEY_LAYOUT_FROM_QUE on class CL_UWS_SURVEY_FORM_API has no exception.

Method VALIDATE_ELMNT_ATTR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_NEW_ELEMENT_DATA	Call by reference	☐	Type reference (TYPE)	UWS_T_SERVICE_PARAMETER		Service Parameter	20070620
2	Importing	IV_ELEMENT_TYPE	Call by reference	☐	Type reference (TYPE)	UWS_ELEMENT_TYPE		Questionnaire Element Type	20070705

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

History

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