SAP ABAP Class CL_SOAP_UDS_CONFIGURATION (User defined search: configuration wrapper)

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

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SOAP_UDS_CONFIG_EXTRACTION	Access interface for UDS configuration. (Runtime usage)	20121029

Properties

Class	CL_SOAP_UDS_CONFIGURATION
Short Description	User defined search: configuration wrapper
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SOAP_USER_DEFINED_SEARCH	User defined search
Created	20121024	SAP
Last change	20140121	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	IF_ESD_WS_QUERY	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SOAP_UDS_CONFIG_EXTRACTION	☐	☐	Access interface for UDS configuration. (Runtime usage)	20121029

Friends

Class CL_SOAP_UDS_CONFIGURATION has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_OBJ_NAME	Constant	Public	☐	Type reference (TYPE)	SUDS_DESCRIPTION	'OBJ_NAME'	Description	20121130
2	CO_OBJ_NAME_EXT	Constant	Public	☐	Type reference (TYPE)	SUDS_DESCRIPTION	IF_ESD_WS_QUERY=>C_NAME	Description	20121130
3	CO_OBJ_NAME_EXT_NS	Constant	Public	☐	Type reference (TYPE)	SUDS_DESCRIPTION	IF_ESD_WS_QUERY=>C_NAMESPACE	Description	20121130
4	CO_OBJ_TYPE	Constant	Public	☐	Type reference (TYPE)	SUDS_DESCRIPTION	'OBJ_TYPE'	Description	20121130
5	CO_OBJ_TYPE_EXT	Constant	Public	☐	Type reference (TYPE)	SUDS_DESCRIPTION	IF_ESD_WS_QUERY=>C_OBJ_TYPE	Description	20121130
6	CO_OPER_NAME	Constant	Public	☐	Type reference (TYPE)	SUDS_DESCRIPTION	'OPER_NAME'	Description	20121130
7	CO_OPER_NAME_EXT	Constant	Public	☐	Type reference (TYPE)	SUDS_DESCRIPTION	IF_ESD_WS_QUERY=>C_OP_NAME	Description	20121130
8	GC_ADDRESSING_TYPE	Constant	Private	☐	See coding				20121102
9	GC_CONFIG_STATUS	Constant	Public	☐	See coding				20121025

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_CONSISTENCY	Instance method	Public	Method	Check consistency of a configuration	20121206
2	DELETE_CONFIGURATION	Instance method	Public	Method	Delete a config	20121030
3	GET_CONFIGURATIONS	Instance method	Public	Method	Search for configs using range tables	20121102
4	GET_MAPPING	Instance method	Public	Method	Get one mapping between internal and external names	20121214
5	GET_SEARCH_PARAMETERS	Instance method	Public	Method	Get search parameters belonging to this config	20121029
6	LOCK_CONFIG	Instance method	Public	Method	Lock config	20121210
7	MAP_EXT_OT_INT	Instance method	Public	Method	Map Interface/Operation from External to Internal	20121220
8	SELECT_MAPPING	Instance method	Public	Method	Search for mappings between internal and external names	20121214
9	SET_SEARCH_PARAMETERS	Instance method	Public	Method	Assign search parameters belonging to this config	20121025
10	SET_STATUS	Instance method	Public	Method	Sets configuration to be Active or Inactive	20121130
11	UNLOCK_CONFIG	Instance method	Public	Method	Unlock config	20121210

Events

Class CL_SOAP_UDS_CONFIGURATION has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TS_CONFIGURATION	Public	See coding			20121030	begin of ts_configuration, interface_name type srt_wsp_dt_obj_name, operation_name type srt_wsp_dt_obj_name, extraction_type type srt_uds_extraction_type, status type srt_uds_config_status, change_user type syuname, change_timestamp type timestamp, end of ts_configuration
2	TS_SEARCH_PARAMETER	Public	Type reference (TYPE)	IF_SOAP_UDS_CONFIG_EXTRACTION=>TS_SEARCH_PARAMETER		20121031
3	TT_CONFIGURATION	Public	See coding			20121030	tt_configuration type standard table of ts_configuration
4	TT_CONFIG_MAPPING	Public	See coding			20121214	tt_config_mapping type standard table of srt_uds_config_m
5	TT_INTERFACE_EXT_RANGE	Public	See coding			20121214	tt_interface_ext_range type range of srt_uds_obj_name_ext
6	TT_INTERFACE_NSP_RANGE	Public	See coding			20121214	tt_interface_nsp_range type range of srt_uds_obj_name_ext_ns
7	TT_INTERFACE_RANGE	Public	See coding			20121116	tt_interface_range type range of srt_wsp_dt_obj_name
8	TT_OBJ_TYPE_EXT_RANGE	Public	See coding			20121214	tt_obj_type_ext_range type range of srt_uds_obj_type
9	TT_OPERATION_EXT_RANGE	Public	See coding			20121214	tt_operation_ext_range type range of srt_uds_oper_name_ext
10	TT_OPERATION_RANGE	Public	See coding			20121106	tt_operation_range type range of srt_wsp_dt_obj_name
11	TT_SEARCH_PARAMETER	Public	See coding			20121029	tt_search_parameter type sorted table of ts_search_parameter with non-unique key search_name
12	TT_SEARCH_PARAM_UNSORTED	Public	See coding			20121203	tt_search_param_unsorted type standard table of ts_search_parameter

Method Signatures

Method CHECK_CONSISTENCY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_FIELD_LIST	Call by reference	☐	Type reference (TYPE)	SUDS_FIELD_DT_LIST_WS		Single Field Design Time Information WS	20121210
2	Importing	IV_INTERFACE	Call by reference	☐	Type reference (TYPE)	SRT_WSP_DT_OBJ_NAME		WSP Name of Interface Object	20121206
3	Importing	IV_OPERATION	Call by reference	☐	Type reference (TYPE)	SRT_WSP_DT_OBJ_NAME		WSP Name of Interface Object	20121206
4	Returning	RV_IS_CONSISTENT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20121206

#	Exception	Resumable	Description	Created on
1	CX_SOAP_UDS_CONFIG	☐	Exception in config	20121206

Method DELETE_CONFIGURATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_INTERFACE	Call by reference	☐	Type reference (TYPE)	SRT_WSP_DT_OBJ_NAME			20121030
2	Importing	IV_OPERATION	Call by reference	☐	Type reference (TYPE)	SRT_WSP_DT_OBJ_NAME			20121030

#	Exception	Resumable	Description	Created on
1	CX_SOAP_UDS_CONFIG	☐	Exception in config	20121204

Method GET_CONFIGURATIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CONFIGURATION	Call by reference	☐	Type reference (TYPE)	TT_CONFIGURATION			20121102
2	Importing	IT_INTERFACE_RANGE	Call by reference	☐	Type reference (TYPE)	TT_INTERFACE_RANGE			20121106
3	Importing	IT_OPERATION_RANGE	Call by reference	☐	Type reference (TYPE)	TT_OPERATION_RANGE			20121106
4	Importing	IT_TIMEZONE	Call by reference	☑	Type reference (TYPE)	TZNZONE		Time Zone	20121213

#	Exception	Resumable	Description	Created on
1	CX_SOAP_UDS_CONFIG	☐	Exception in config	20121204

Method GET_MAPPING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_INTERFACE	Call by reference	☐	Type reference (TYPE)	SRT_UDS_OBJ_NAME		Object name	20121214
2	Importing	IV_OPERATION	Call by reference	☐	Type reference (TYPE)	SRT_UDS_OBJ_NAME		Object name	20121214
3	Returning	RS_CONFIG_MAPPING	Value transfer	☐	Type reference (TYPE)	SRT_UDS_CONFIG_M		User defined search: mapping external to internal names	20121214

Method GET_MAPPING on class CL_SOAP_UDS_CONFIGURATION has no exception.

Method GET_SEARCH_PARAMETERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SEARCH_PARAMETER	Call by reference	☐	Type reference (TYPE)	TT_SEARCH_PARAMETER			20121029
2	Importing	IV_EXTRACTION_TYPE	Call by reference	☑	Type reference (TYPE)	SRT_UDS_EXTRACTION_TYPE			20121029
3	Importing	IV_INTERFACE	Call by reference	☐	Type reference (TYPE)	SRT_WSP_DT_OBJ_NAME			20121029
4	Importing	IV_OPERATION	Call by reference	☐	Type reference (TYPE)	SRT_WSP_DT_OBJ_NAME			20121029
5	Importing	IV_SENDER_IBC	Call by reference	☐	Type reference (TYPE)	SRT_WSP_IBC_ID	''		20121030

#	Exception	Resumable	Description	Created on
1	CX_SOAP_UDS_CONFIG	☐	Exception in config	20121210

Method LOCK_CONFIG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ADDRESSING_TYPE	Call by reference	☐	Type reference (TYPE)	SRT_UDS_ADDRESSING_TYPE		Type of external addressing used (e.g. PI, IBC, ...)	20121210
2	Importing	IV_INTERFACE	Call by reference	☐	Type reference (TYPE)	SRT_WSP_DT_OBJ_NAME		WSP Name of Interface Object	20121210
3	Importing	IV_OPERATION	Call by reference	☐	Type reference (TYPE)	SRT_WSP_DT_OBJ_NAME		WSP Name of Interface Object	20121210

#	Exception	Resumable	Description	Created on
1	CX_SOAP_UDS_CONFIG	☐	Exception in config	20121210

Method MAP_EXT_OT_INT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_CONFIGURED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20121220
2	Exporting	EV_INTERFACE	Call by reference	☐	Type reference (TYPE)	SRT_UDS_OBJ_NAME		Internal Interface Name	20121220
3	Exporting	EV_OPERATION	Call by reference	☐	Type reference (TYPE)	SRT_UDS_OBJ_NAME		Internal Operation Name	20121220
4	Importing	IV_INTERFACE_EXT	Call by reference	☐	Type reference (TYPE)	SRT_UDS_OBJ_NAME_EXT		Web Service Object external Name	20121220
5	Importing	IV_INTERFACE_NSP	Call by reference	☐	Type reference (TYPE)	SRT_UDS_OBJ_NAME_EXT_NS		Web Service Object external Namespace	20121220
6	Importing	IV_OPERATION_EXT	Call by reference	☐	Type reference (TYPE)	SRT_UDS_OBJ_NAME_EXT		Web Service Object external Name	20121220

Method MAP_EXT_OT_INT on class CL_SOAP_UDS_CONFIGURATION has no exception.

Method SELECT_MAPPING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CONFIG_MAPPING	Call by reference	☐	Type reference (TYPE)	TT_CONFIG_MAPPING		User defined search: mapping external to internal names	20121214
2	Importing	IT_RANGE_INTERFACE_EXT	Call by reference	☑	Type reference (TYPE)	TT_INTERFACE_EXT_RANGE		Web Service Object external Name	20121214
3	Importing	IT_RANGE_INTERFACE_NSP	Call by reference	☑	Type reference (TYPE)	TT_INTERFACE_NSP_RANGE		Web Service Object external Name	20121214
4	Importing	IT_RANGE_OPERATION_EXT	Call by reference	☑	Type reference (TYPE)	TT_OPERATION_EXT_RANGE		Web Service Object external Name	20121214

Method SELECT_MAPPING on class CL_SOAP_UDS_CONFIGURATION has no exception.

Method SET_SEARCH_PARAMETERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SEARCH_PARAMETER	Call by reference	☐	Type reference (TYPE)	TT_SEARCH_PARAMETER			20121025
2	Importing	IV_EXTRACTION_TYPE	Call by reference	☐	Type reference (TYPE)	SRT_UDS_EXTRACTION_TYPE			20121025
3	Importing	IV_INTERFACE	Call by reference	☐	Type reference (TYPE)	SRT_WSP_DT_OBJ_NAME			20121025
4	Importing	IV_INTERFACE_EXT	Call by reference	☑	Type reference (TYPE)	SRT_UDS_OBJ_NAME_EXT		Web Service Object external Name	20121130
5	Importing	IV_INTERFACE_NSP	Call by reference	☑	Type reference (TYPE)	SRT_UDS_OBJ_NAME_EXT_NS		Web Service Object external Name	20121130
6	Importing	IV_OPERATION	Call by reference	☐	Type reference (TYPE)	SRT_WSP_DT_OBJ_NAME			20121025
7	Importing	IV_OPERATION_EXT	Call by reference	☑	Type reference (TYPE)	SRT_UDS_OBJ_NAME_EXT		Web Service Object external Name	20121130
8	Importing	IV_STATUS	Call by reference	☐	Type reference (TYPE)	SRT_UDS_CONFIG_STATUS	'A'	User defined search: status of configuration entry	20121119

#	Exception	Resumable	Description	Created on
1	CX_SOAP_UDS_CONFIG	☐	Exception in config	20121204

Method SET_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_INTERFACE	Call by reference	☐	Type reference (TYPE)	SRT_WSP_DT_OBJ_NAME		WSP Name of Interface Object	20121130
2	Importing	IV_OPERATION	Call by reference	☐	Type reference (TYPE)	SRT_WSP_DT_OBJ_NAME		WSP Name of Interface Object	20121130
3	Importing	IV_STATUS	Call by reference	☐	Type reference (TYPE)	SRT_UDS_CONFIG_STATUS		User defined search: status of configuration entry	20121130

#	Exception	Resumable	Description	Created on
1	CX_SOAP_UDS_CONFIG	☐	Exception in config	20121204

Method UNLOCK_CONFIG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ADDRESSING_TYPE	Call by reference	☐	Type reference (TYPE)	SRT_UDS_ADDRESSING_TYPE		Type of external addressing used (e.g. PI, IBC, ...)	20121210
2	Importing	IV_INTERFACE	Call by reference	☐	Type reference (TYPE)	SRT_WSP_DT_OBJ_NAME		WSP Name of Interface Object	20121210
3	Importing	IV_OPERATION	Call by reference	☐	Type reference (TYPE)	SRT_WSP_DT_OBJ_NAME		WSP Name of Interface Object	20121210

Method UNLOCK_CONFIG on class CL_SOAP_UDS_CONFIGURATION has no exception.

History

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