SAP ABAP Class CL_SOAP_UDS_STRUCTURE_ELEMENT (User Defined Search: Structure Element)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ESI-WS-ABA-RT (Application Component) WebServices ABAP Runtime
     ⤷ SOAP_USER_DEFINED_SEARCH (Package) User defined search

Properties

Class	CL_SOAP_UDS_STRUCTURE_ELEMENT
Short Description	User Defined Search: Structure Element
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	SOAP_USER_DEFINED_SEARCH	User defined search
Created	20121115	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_SOAP_UDS_STRUCTURE_ELEMENT has no forward declaration.

Interfaces

Class CL_SOAP_UDS_STRUCTURE_ELEMENT has no interface implemented.

Friends

Class CL_SOAP_UDS_STRUCTURE_ELEMENT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CHILDREN	Instance attribute	Public	☑	Type reference (TYPE)	T_CHILDREN			20121115
2	ID	Instance attribute	Public	☑	Type reference (TYPE)	SRT_UDS_STRUCT_ELEMENT_ID		RAL: Structure Element ID	20121115
3	NAME	Instance attribute	Public	☑	Type reference (TYPE)	SRT_UDS_STRUCT_ELEMENT_NAME		RAL: Structure Element Name	20121115
4	NAME_SHORT	Instance attribute	Public	☑	Type reference (TYPE)	SRT_UDS_STRUCT_ELEMENT_NAME		RAL: Structured Element Name	20121115
5	NAME_SHORT_EXT	Instance attribute	Public	☐	Type reference (TYPE)	SRT_UDS_STRUCT_ELEMENT_NAME		RAL: Structured Element Name	20121115
6	PARENT	Instance attribute	Public	☑	Object reference (TYPE REF TO)	CL_SOAP_UDS_STRUCTURE_ELEMENT		Read Access Logging: Structure Element	20121115
7	XPATH	Instance attribute	Public	☑	Type reference (TYPE)	STRING		XPath	20121115

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_CHILD	Instance method	Public	Method	Add Child of Element	20121115
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20121115
3	CREATE	Static method	Public	Method	Creates new structure element	20121115
4	GET_DISPLAY_NAME	Instance method	Public	Method	Gets readable field name for display purposes	20121115
5	GET_DISPLAY_NAME_SHORT	Instance method	Public	Method	Gets short readable field name for display purposes	20121115
6	GET_DISPLAY_NAME_SHORT_EXT	Instance method	Public	Method	Gets short readable field name with its external datatype	20121115
7	GET_XPATH	Instance method	Public	Method		20121115
8	SET_PARENT	Instance method	Public	Method	Set Parent of Element	20121115

Events

Class CL_SOAP_UDS_STRUCTURE_ELEMENT has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	T_CHILD	Public	See coding			20121115	begin of t_child, child type ref to cl_soap_uds_structure_element, end of t_child
2	T_CHILDREN	Public	See coding			20121115	t_children type standard table of t_child

Method Signatures

Method ADD_CHILD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_CHILD	Call by reference	☐	Object reference (TYPE REF TO)	CL_SOAP_UDS_STRUCTURE_ELEMENT		Read Access Logging: Structure Element	20121115

#	Exception	Resumable	Description	Created on
1	CX_SOAP_UDS_CONFIG	☐		20121126

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ELEMENT_ID	Call by reference	☐	Type reference (TYPE)	SRT_UDS_STRUCT_ELEMENT_ID		RAL: Structured Element ID	20121126
2	Importing	IV_ELEMENT_NAME	Call by reference	☐	Type reference (TYPE)	STRING		RAL: Structured Element Name	20121126
3	Importing	IV_ELEMENT_NAME_EXT	Call by reference	☑	Type reference (TYPE)	STRING		RAL: External Name of Element	20121126
4	Importing	IV_ELEMENT_NAME_SHORT	Call by reference	☐	Type reference (TYPE)	SRT_UDS_STRUCT_ELEMENT_NAME		RAL: Structured Element Name	20121126
5	Importing	IV_XPATH	Call by reference	☑	Type reference (TYPE)	STRING		XPath separated with /	20121115

#	Exception	Resumable	Description	Created on
1	CX_SOAP_UDS_CONFIG	☐	RAL: Exception	20121126

Method CREATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ELEMENT_ID	Call by reference	☐	Type reference (TYPE)	SRT_UDS_STRUCT_ELEMENT_ID		RAL: Structured Element ID	20121126
2	Importing	IV_ELEMENT_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20121126
3	Importing	IV_ELEMENT_NAME_EXT	Call by reference	☑	Type reference (TYPE)	STRING		External Name of Element	20121126
4	Importing	IV_ELEMENT_NAME_SHORT	Call by reference	☐	Type reference (TYPE)	SRT_UDS_STRUCT_ELEMENT_NAME		RAL: Structured Element Name	20121126
5	Importing	IV_XPATH	Call by reference	☑	Type reference (TYPE)	STRING		XPath	20121115
6	Returning	R_ELEMENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_SOAP_UDS_STRUCTURE_ELEMENT		Read Access Logging: Structure Element	20121115

#	Exception	Resumable	Description	Created on
1	CX_SOAP_UDS_CONFIG	☐	RAL: Exception	20121126

Method GET_DISPLAY_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_FIELD_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Read Access Logging: Data Field Name	20121115

#	Exception	Resumable	Description	Created on
1	CX_SOAP_UDS_CONFIG	☐		20121126

Method GET_DISPLAY_NAME_SHORT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_FIELD_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Read Access Logging: Data Field Name	20121115

#	Exception	Resumable	Description	Created on
1	CX_SOAP_UDS_CONFIG	☐		20121126

Method GET_DISPLAY_NAME_SHORT_EXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_FIELD_NAME	Value transfer	☐	Type reference (TYPE)	STRING		RAL: String	20121115

Method GET_DISPLAY_NAME_SHORT_EXT on class CL_SOAP_UDS_STRUCTURE_ELEMENT has no exception.

Method GET_XPATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_XPATH	Value transfer	☐	Type reference (TYPE)	STRING			20121115

Method GET_XPATH on class CL_SOAP_UDS_STRUCTURE_ELEMENT has no exception.

Method SET_PARENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PARENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_SOAP_UDS_STRUCTURE_ELEMENT		Read Access Logging: Structure Element	20121115

#	Exception	Resumable	Description	Created on
1	CX_SOAP_UDS_CONFIG	☐		20121126

History

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