SAP ABAP Class CTS_WS_UTILS (Utility Class)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-CTS-TMS-PLS (Application Component) TMS for non-ABAP (CTS+)
     ⤷ SCTS_WS (Package) CTS: WebServices

Properties

Class	CTS_WS_UTILS
Short Description	Utility Class
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SCTS_WS	CTS: WebServices
Created	20100510	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CTS_WS_UTILS has no forward declaration.

Interfaces

Class CTS_WS_UTILS has no interface implemented.

Friends

Class CTS_WS_UTILS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ERROR_MSG	Constant	Public	☐	Type reference (TYPE)	CHAR1	'E'	ERROR MESSAGE	20110516
2	INFO_MSG	Constant	Public	☐	Type reference (TYPE)	CHAR1	'I'	INFO MESSAGE	20110516
3	IV_LOG_HANDLE	Instance attribute	Private	☐	Type reference (TYPE)	BALLOGHNDL		Application Log: Log Handle	20100510
4	IV_LOG_ITEMS	Instance attribute	Private	☐	Type reference (TYPE)	CTS_WS_LOG_ITEMS		Table of log items from CTS web services runs	20100510
5	IV_LOG_PROGRAM	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Logging program	20100510
6	LOG_EXT_ID	Constant	Public	☐	Type reference (TYPE)	STRING	'Web Services'		20100510
7	LOG_MSGID	Constant	Public	☐	Type reference (TYPE)	STRING	'XT'		20100510
8	LOG_OBJ	Constant	Public	☐	Type reference (TYPE)	STRING	'CTSPLUS'		20100510
9	LOG_SUBOBJ	Constant	Public	☐	Type reference (TYPE)	STRING	'TRA_API'		20100510
10	LOG_TRANS_CODE	Constant	Public	☐	Type reference (TYPE)	STRING	'RFC Call'		20100510
11	MAIN_ERROR_MESSAGE	Instance attribute	Private	☐	Type reference (TYPE)	STRING		main error message text	20121017
12	TRACE_MSG	Constant	Public	☐	Type reference (TYPE)	CHAR1	'T'	TRACE MESSAGE	20110516
13	WARN_MSG	Constant	Public	☐	Type reference (TYPE)	CHAR1	'W'	WARNING MESSAGE	20110516

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_ERROR_TEXT	Instance method	Private	Method	adds error text to the summary error text	20121017
2	CHECK_FOR_MANDATORY	Instance method	Public	Method	Checks whether mandatory values are provided	20100510
3	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20100510
4	CREATE_LOGITEM_FOR_BAPIRET2	Instance method	Public	Method	Converts BAPIRET2 structure to a new CTS_WS_L:OG_ITEM	20100511
5	CREATE_LOGITEM_FOR_MESSAGE	Instance method	Public	Method	Creates a new log item (using message provided)	20100510
6	CREATE_LOGITEM_FOR_TEXT	Instance method	Public	Method	Creates a new log item (using text provided)	20100510
7	GET_ERROR_MESSAGE	Instance method	Public	Method	returns the error text	20121017
8	GET_LOG_ITEMS	Instance method	Public	Method	Returns list of log items	20100526
9	GET_MESSAGE_TEXT	Static method	Private	Method	Gets the message's text	20100511
10	LOG_MESSAGE	Instance method	Public	Method	Logs a message into the application login (tr./slg1)	20100510
11	LOG_TEXT	Instance method	Public	Method	Logs a text (as it is) into the application login (tr./slg1)	20100510

Events

Class CTS_WS_UTILS has no event.

Types

Class CTS_WS_UTILS has no local type.

Method Signatures

Method ADD_ERROR_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ERROR_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20121017

Method ADD_ERROR_TEXT on class CTS_WS_UTILS has no exception.

Method CHECK_FOR_MANDATORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PARAM_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Name of the parameter	20100510
2	Importing	PARAM_VALUE	Value transfer	☐	Type reference (TYPE)	STRING		Value of the parameter	20100510
3	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	I		'T' or 'F' values	20100511

Method CHECK_FOR_MANDATORY on class CTS_WS_UTILS has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LOG_HANDLE	Value transfer	☑	Type reference (TYPE)	BALLOGHNDL		Handle to log object	20100510
2	Importing	LOG_ITEMS	Call by reference	☐	Type reference (TYPE)	CTS_WS_LOG_ITEMS		List of log items	20100510
3	Importing	LOG_PROGRAM	Value transfer	☐	Type reference (TYPE)	STRING		Logging program	20100510

#	Exception	Resumable	Description	Created on
1	LOGGING_ERROR	☐	Logging error	20100510

Method CREATE_LOGITEM_FOR_BAPIRET2 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INPUT	Value transfer	☐	Type reference (TYPE)	BAPIRET2		Return Parameter(s)	20100511
2	Returning	ITEM	Value transfer	☐	Type reference (TYPE)	CTS_WS_LOG_ITEM		Log item	20100511

Method CREATE_LOGITEM_FOR_BAPIRET2 on class CTS_WS_UTILS has no exception.

Method CREATE_LOGITEM_FOR_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MESSAGE	Value transfer	☐	Type reference (TYPE)	BAL_S_MSG		Message to be logged	20100511

Method CREATE_LOGITEM_FOR_MESSAGE on class CTS_WS_UTILS has no exception.

Method CREATE_LOGITEM_FOR_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SEVERITY	Value transfer	☐	Type reference (TYPE)	CHAR1	'D'	Type of logging	20100510
2	Importing	TEXT	Value transfer	☐	Type reference (TYPE)	STRING		Text to log	20100510

Method CREATE_LOGITEM_FOR_TEXT on class CTS_WS_UTILS has no exception.

Method GET_ERROR_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ERROR_TEXT	Value transfer	☐	Type reference (TYPE)	STRING		error text	20121017

Method GET_ERROR_MESSAGE on class CTS_WS_UTILS has no exception.

Method GET_LOG_ITEMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ITEMS	Value transfer	☐	Type reference (TYPE)	CTS_WS_LOG_ITEMS		List of log items	20100526

Method GET_LOG_ITEMS on class CTS_WS_UTILS has no exception.

Method GET_MESSAGE_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MESSAGE	Value transfer	☐	Type reference (TYPE)	BAL_S_MSG		Application Log: Message Data	20100511
2	Returning	TEXT	Value transfer	☐	Type reference (TYPE)	STRING		Message's text	20100511

Method GET_MESSAGE_TEXT on class CTS_WS_UTILS has no exception.

Method LOG_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LOG_MESSAGE	Value transfer	☑	Type reference (TYPE)	BAL_S_MSG		Message to be logged	20100510

#	Exception	Resumable	Description	Created on
1	LOGGING_ERROR	☐	Logging error	20100510

Method LOG_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LOG_TEXT	Value transfer	☐	Type reference (TYPE)	STRING		Text to be logged	20100510
2	Importing	SEVERITY	Value transfer	☐	Type reference (TYPE)	CHAR1	'I'	Type of the log message	20100510

#	Exception	Resumable	Description	Created on
1	LOGGING_ERROR	☐	Logging error	20100510

History

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