SAP ABAP Class CL_SOAP_UDS_CONFIG (UDS: Single configuratin)

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_CONFIG
Short Description	UDS: Single configuratin
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SOAP_USER_DEFINED_SEARCH	User defined search
Created	20130123	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	CL_SOAP_UDS_CONFIGURATION	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	IF_SOAP_UDS_CONFIG_EXTRACTION	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_SOAP_UDS_CONFIG has no interface implemented.

Friends

Class CL_SOAP_UDS_CONFIG has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_ADDRESSING_TYPE	Constant	Private	☐	See coding		IS INITIAL		20130124
2	GC_MODE	Constant	Public	☐	See coding		IS INITIAL		20130205
3	GC_STATUS	Constant	Public	☐	See coding		IS INITIAL		20130311
4	MS_CONFIG	Instance attribute	Private	☐	Type reference (TYPE)	CL_SOAP_UDS_CONFIGURATION=>TS_CONFIGURATION			20130125
5	MT_SEARCH_PARAMETER	Instance attribute	Private	☐	Type reference (TYPE)	IF_SOAP_UDS_CONFIG_EXTRACTION=>TT_SEARCH_PARAMETER		Search parameters of the configuration	20130124
6	MV_ADDRESSING_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	SRT_UDS_ADDRESSING_TYPE		Type of external addressing used (e.g. PI, IBC, ...)	20130124
7	MV_DIRTY	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20130129
8	MV_INTERFACE_EXT	Instance attribute	Private	☐	Type reference (TYPE)	QNAME		Qualified Name	20130123
9	MV_MODE	Instance attribute	Private	☐	Type reference (TYPE)	TY_MODE		Mode of the current config	20130205
10	MV_OPERATION_EXT	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20130123

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_PARAM	Instance method	Public	Method	Adds a single search parameter into current config	20130130
2	ADD_PARAMS	Instance method	Public	Method	Adds search parameters into current config	20130124
3	CANCEL	Instance method	Public	Method	Cancels the session of edit	20130124
4	CHECK	Instance method	Public	Method	Checks the XPaths against DT object	20130125
5	CLOSE	Instance method	Public	Method	Closees the current session of config	20130201
6	CONSTRUCTOR	Instance method	Private	Constructor	CONSTRUCTOR	20130123
7	CONVERT_LOCAL_TIME	Static method	Public	Method	Converts from UTC to local time	20130123
8	CREATE	Static method	Public	Method	Creates a new configuration	20130123
9	DELETE	Instance method	Public	Method	Deletes the current configuration	20130123
10	DELETE_PARAMS	Instance method	Public	Method	Removes search parameters from current config	20130124
11	EDIT	Instance method	Public	Method	Switches to edit mode	20130123
12	EXIST	Static method	Public	Method	Checks if given configuration exists in database	20130222
13	GET_EXTRACTION_TYPE	Instance method	Public	Method	Returns extraction type (direct/async)	20130125
14	GET_INTERFACE	Instance method	Public	Method	Returns interface's internal name	20130123
15	GET_INTERFACE_EXT	Instance method	Public	Method	Returns interface's external name	20130123
16	GET_OPERATION	Instance method	Public	Method	Returns interface's internal name	20130123
17	GET_OPERATION_EXT	Instance method	Public	Method	Returns operation's external name	20130123
18	GET_PARAMS	Instance method	Public	Method	Returns search parameters with the given search name	20130124
19	GET_STATUS	Instance method	Public	Method	Returns if the current config is acitve or inactive	20130125
20	GET_TIMESTAMP	Instance method	Public	Method	Returns the timestamp when it was last changed	20130125
21	GET_TIMEZONE	Static method	Public	Method	Returns the user local time zone	20130212
22	GET_TIMEZONE_TEXT	Static method	Public	Method	Returns the user local time zone description	20130212
23	GET_USER	Instance method	Public	Method	Returns user last changed, otherwise INITIAL	20130311
24	IS_CONSISTENT	Instance method	Private	Method	Returns if the current state of config is consistent	20130125
25	LOAD_FROM_DB	Static method	Private	Method	Loads an configuration from database	20130212
26	LOCK	Instance method	Private	Method	Locks the current configuration	20130123
27	OPEN	Static method	Public	Method	Opens an exisiting configuration	20130123
28	OPEN_FROM_ITAB	Static method	Private	Method	Opens an exisiting configuration from internal table	20130212
29	SAVE	Instance method	Public	Method	Saves a configuration	20130123
30	SEARCH_MESSAGES	Instance method	Public	Method	Searches for existing runtime messages	20130128
31	SET_EXTRACTION_TYPE	Instance method	Public	Method	Sets extraction type (direct/async)	20130125
32	SET_PARAMS	Instance method	Public	Method	Sets search parameters into current config	20130130
33	SET_STATUS	Instance method	Public	Method	Activates or deactivates the current configuration	20130125
34	SIMULATE	Instance method	Public	Method	Simulates the current configuration with given message	20130123
35	UNLOCK	Instance method	Private	Method	Unlocks the current configuration	20130123

Events

Class CL_SOAP_UDS_CONFIG has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TS_SOAP_UDS_INDEX	Public	See coding			20130128	begin of ts_soap_uds_index, search_name type string, search_value type srt_uds_search_value, end of ts_soap_uds_index
2	TT_SOAP_UDS_CONFIG	Public	See coding			20130212	tt_soap_uds_config type sorted table of srt_uds_config_v with non-unique key interface operation
3	TT_SOAP_UDS_INDEX	Public	See coding			20130128	tt_soap_uds_index type sorted table of ts_soap_uds_index with non-unique key search_name
4	TY_MODE	Public	See coding			20130205	ty_mode type c length 2
5	TY_STATUS	Public	Type reference (TYPE)	SRT_UDS_CONFIG_STATUS		20130311

Method Signatures

Method ADD_PARAM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_PARAM	Call by reference	☐	Type reference (TYPE)	IF_SOAP_UDS_CONFIG_EXTRACTION=>TS_SEARCH_PARAMETER			20130130

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

Method ADD_PARAMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_PARAM	Call by reference	☐	Type reference (TYPE)	IF_SOAP_UDS_CONFIG_EXTRACTION=>TT_SEARCH_PARAMETER			20130124

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

Method CANCEL Signature

Method CANCEL on class CL_SOAP_UDS_CONFIG has no parameter.

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

Method CHECK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_FIELD	Call by reference	☐	Type reference (TYPE)	SUDS_FIELD_DT_LIST_WS		Single Field Design Time Information WS	20130129
2	Returning	RV_CONSISTENT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20130125

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

Method CLOSE Signature

Method CLOSE on class CL_SOAP_UDS_CONFIG has no parameter.

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

Method CONSTRUCTOR 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	20130123
2	Importing	IV_INTERFACE_EXT	Call by reference	☐	Type reference (TYPE)	QNAME		Qualified Name	20130123
3	Importing	IV_OPERATION	Call by reference	☐	Type reference (TYPE)	SRT_WSP_DT_OBJ_NAME		WSP Name of Interface Object	20130123
4	Importing	IV_OPERATION_EXT	Call by reference	☐	Type reference (TYPE)	STRING			20130123

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

Method CONVERT_LOCAL_TIME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TIMESTAMP	Call by reference	☐	Type reference (TYPE)	TIMESTAMP		UTC Time Stamp in Short Form (YYYYMMDDhhmmss)	20130123
2	Importing	IV_TIMEZONE	Call by reference	☑	Type reference (TYPE)	TZNZONE		Time Zone	20130123
3	Returning	RV_TIMESTAMP	Value transfer	☐	Type reference (TYPE)	TIMESTAMP		UTC Time Stamp in Short Form (YYYYMMDDhhmmss)	20130123

Method CONVERT_LOCAL_TIME on class CL_SOAP_UDS_CONFIG has no exception.

Method CREATE 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		Qualified Name	20130123
2	Importing	IV_INTERFACE_EXT	Call by reference	☐	Type reference (TYPE)	QNAME		Qualified Name	20130123
3	Importing	IV_OPERATION	Call by reference	☐	Type reference (TYPE)	SRT_WSP_DT_OBJ_NAME		WSP Name of Interface Object	20130123
4	Importing	IV_OPERATION_EXT	Call by reference	☐	Type reference (TYPE)	STRING			20130123
5	Returning	RO_CONFIG	Value transfer	☐	Object reference (TYPE REF TO)	CL_SOAP_UDS_CONFIG		UDS: Single configuratin	20130123

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

Method DELETE Signature

Method DELETE on class CL_SOAP_UDS_CONFIG has no parameter.

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

Method DELETE_PARAMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_PARAM	Call by reference	☐	Type reference (TYPE)	IF_SOAP_UDS_CONFIG_EXTRACTION=>TT_SEARCH_PARAMETER			20130124

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

Method EDIT Signature

Method EDIT on class CL_SOAP_UDS_CONFIG has no parameter.

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

Method EXIST 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			20130222
2	Importing	IV_OPERATION	Call by reference	☐	Type reference (TYPE)	SRT_WSP_DT_OBJ_NAME			20130222
3	Returning	RV_EXIST	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20130222

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

Method GET_EXTRACTION_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_EXTRACTION_TYPE	Value transfer	☐	Type reference (TYPE)	IF_SOAP_UDS_CONFIG_EXTRACTION=>TY_EXTRACTION_TYPE			20130125

Method GET_EXTRACTION_TYPE on class CL_SOAP_UDS_CONFIG has no exception.

Method GET_INTERFACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_INTERFACE	Value transfer	☐	Type reference (TYPE)	SRT_WSP_DT_OBJ_NAME		WSP Name of Interface Object	20130123

Method GET_INTERFACE on class CL_SOAP_UDS_CONFIG has no exception.

Method GET_INTERFACE_EXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_INTERFACE	Value transfer	☐	Type reference (TYPE)	QNAME			20130123

Method GET_INTERFACE_EXT on class CL_SOAP_UDS_CONFIG has no exception.

Method GET_OPERATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_OPERATION	Value transfer	☐	Type reference (TYPE)	SRT_WSP_DT_OBJ_NAME			20130123

Method GET_OPERATION on class CL_SOAP_UDS_CONFIG has no exception.

Method GET_OPERATION_EXT Signature

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

Method GET_OPERATION_EXT on class CL_SOAP_UDS_CONFIG has no exception.

Method GET_PARAMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_PARAM	Value transfer	☐	Type reference (TYPE)	IF_SOAP_UDS_CONFIG_EXTRACTION=>TT_SEARCH_PARAMETER			20130129
2	Importing	IV_NAME	Call by reference	☑	Type reference (TYPE)	SRT_UDS_SEARCH_NAME		WS runtime: UDS search name	20130124

Method GET_PARAMS on class CL_SOAP_UDS_CONFIG has no exception.

Method GET_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_STATUS	Value transfer	☐	Type reference (TYPE)	SRT_UDS_CONFIG_STATUS		User defined search: status of configuration entry	20130125

Method GET_STATUS on class CL_SOAP_UDS_CONFIG has no exception.

Method GET_TIMESTAMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TIMESTAMP	Value transfer	☐	Type reference (TYPE)	TIMESTAMP		UTC Time Stamp in Short Form (YYYYMMDDhhmmss)	20130125

Method GET_TIMESTAMP on class CL_SOAP_UDS_CONFIG has no exception.

Method GET_TIMEZONE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TIMEZONE	Value transfer	☐	Type reference (TYPE)	TZNZONE		Time Zone	20130212

Method GET_TIMEZONE on class CL_SOAP_UDS_CONFIG has no exception.

Method GET_TIMEZONE_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_TIMEZONE_TEXT	Value transfer	☐	Type reference (TYPE)	TZNDESCTZN		Time Zone	20130212

Method GET_TIMEZONE_TEXT on class CL_SOAP_UDS_CONFIG has no exception.

Method GET_USER Signature

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

Method GET_USER on class CL_SOAP_UDS_CONFIG has no exception.

Method IS_CONSISTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_CONSISTENT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20130125

Method IS_CONSISTENT on class CL_SOAP_UDS_CONFIG has no exception.

Method LOAD_FROM_DB Signature

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

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

Method LOCK Signature

Method LOCK on class CL_SOAP_UDS_CONFIG has no parameter.

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

Method OPEN 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			20130123
2	Importing	IV_MODE	Call by reference	☐	Type reference (TYPE)	TY_MODE	GC_MODE-DISPLAY		20130205
3	Importing	IV_OPERATION	Call by reference	☐	Type reference (TYPE)	SRT_WSP_DT_OBJ_NAME			20130123
4	Returning	RO_CONFIG	Value transfer	☐	Object reference (TYPE REF TO)	CL_SOAP_UDS_CONFIG		UDS: Single configuratin	20130123

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

Method OPEN_FROM_ITAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_CONFIG_DATA	Call by reference	☐	Type reference (TYPE)	TT_SOAP_UDS_CONFIG		Generated Table for View	20130212
2	Importing	IV_MODE	Call by reference	☐	Type reference (TYPE)	TY_MODE	GC_MODE-DISPLAY		20130212
3	Returning	RO_CONFIG	Value transfer	☐	Object reference (TYPE REF TO)	CL_SOAP_UDS_CONFIG		UDS: Single configuratin	20130212

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

Method SAVE Signature

Method SAVE on class CL_SOAP_UDS_CONFIG has no parameter.

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

Method SEARCH_MESSAGES 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)	SRT_MSELECT_RESULT_T		Message Select Result	20130128
2	Importing	IV_MESSAGE_ID	Call by reference	☑	Type reference (TYPE)	STRING			20130128
3	Importing	IV_METHOD	Call by reference	☐	Type reference (TYPE)	SRT_UDS_SEARCH_METHOD		UDS: search method for messages	20130128
4	Importing	IV_TIME_RANGE	Call by reference	☑	Type reference (TYPE)	SRT_UDS_TIME_RANGE		UDS: Time range	20130128

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

Method SET_EXTRACTION_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_EXTRACTION_TYPE	Call by reference	☐	Type reference (TYPE)	IF_SOAP_UDS_CONFIG_EXTRACTION=>TY_EXTRACTION_TYPE			20130125

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

Method SET_PARAMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_PARAM	Call by reference	☐	Type reference (TYPE)	IF_SOAP_UDS_CONFIG_EXTRACTION=>TT_SEARCH_PARAMETER			20130130

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

Method SET_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STATUS	Call by reference	☐	Type reference (TYPE)	SRT_UDS_CONFIG_STATUS		User defined search: status of configuration entry	20130125

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

Method SIMULATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SEARCH_INDEX	Call by reference	☐	Type reference (TYPE)	TT_SOAP_UDS_INDEX			20130128
2	Importing	IV_MESSAGE	Call by reference	☐	Type reference (TYPE)	SRT_MSELECT_RESULT		Message Select Result	20130128

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

Method UNLOCK Signature

Method UNLOCK on class CL_SOAP_UDS_CONFIG has no parameter.
Method UNLOCK on class CL_SOAP_UDS_CONFIG has no exception.

History

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