SAP ABAP Class CL_CTS_CONFIG_WD_ASSISTANCE (Assistance Class for Web Dynpro Component CTS_CONFIGURATION)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-CTS-TMS-CTR (Application Component) Central CTS # Transport Management
     ⤷ SCTS_DIST_CTL_CONFIGURATION_WD (Package) Central CTS - Configuration User Interface (W)eb (D)ynpro

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_WD_COMPONENT_ASSISTANCE	Basis for a Web Dynpro assistance class	20110926
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_CTS_CONFIG_WD_CONSTANTS	cCTS Configuration - Interface for Constants	20111130

Properties

Class	CL_CTS_CONFIG_WD_ASSISTANCE
Short Description	Assistance Class for Web Dynpro Component CTS_CONFIGURATION
Super Class	CL_WD_COMPONENT_ASSISTANCE	Basis for a Web Dynpro assistance class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SCTS_DIST_CTL_CONFIGURATION_WD	Central CTS - Configuration User Interface (W)eb (D)ynpro
Created	20110926	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)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_CTS_CONFIG_WD_CONSTANTS	☐	☐	cCTS Configuration - Interface for Constants	20111130

Friends

Class CL_CTS_CONFIG_WD_ASSISTANCE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MT_DOCUMENTATION_CACHE	Instance attribute	Private	☐	Type reference (TYPE)	TY_DOCU_INFO_TAB			20120215
2	MT_HISTORY_TAB	Instance attribute	Private	☐	Type reference (TYPE)	TY_HISTORY_TAB			20120215
3	MV_CURRENT_HISTORY_ENTRY	Instance attribute	Public	☑	Type reference (TYPE)	I			20120215
4	MV_LANGUAGE	Instance attribute	Private	☐	Type reference (TYPE)	SYLANGU		Language Key	20120215
5	MV_NUMBER_OF_ENTRIES	Instance attribute	Public	☑	Type reference (TYPE)	I			20120215

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_DOCUMENTATION_INFO	Instance method	Private	Method	Addition of an Entry to the Table MT_DOCUMENTATION_TAB	20120215
2	CHECK_DOCUMETATION_EXISTS	Instance method	Private	Method	Checks whether a Documentation exists	20121017
3	CHECK_MESSAGE_DOCU_EXISTS	Instance method	Private	Method	Checks whether a Message has a Long Text	20121017
4	GET_CURRENT_DOCU_INFO	Instance method	Private	Method	Retrieval of the Current Entry from MT_DOCUMENTATION_TAB	20120215
5	GET_DOCUMENTATION	Instance method	Private	Method	Get the Documentation	20120215
6	GET_MESSAGE_DOCUMENTATION	Instance method	Private	Method	Get the Long Text of a Message	20120215
7	GET_MESSAGE_FROM_EXCEPTION	Instance method	Public	Method	Get a Message from an Exception	20130129
8	INITIALIZE	Instance method	Private	Method	Initialization	20120215
9	READ_DOCUMENTATION	Instance method	Public	Method	Returns the Documentation	20121017
10	REPLACE_TEXT_SYMBOLS	Instance method	Private	Method	Replace the Text Symbols within the Documentation	20121203
11	SET_DOCUMENT	Instance method	Public	Method	Set the Data for a Long Text of a Document	20121017
12	SET_LANGUAGE	Instance method	Private	Method	Set the Language Key	20120215
13	SET_MESSAGE	Instance method	Public	Method	Set the Data for a Long Text of a Message	20120215

Events

Class CL_CTS_CONFIG_WD_ASSISTANCE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_DOCU_INFO	Private	See coding			20120215	BEGIN OF ty_docu_info, index TYPE i, message TYPE symsg, if_message TYPE REF TO if_message, docu_object TYPE ty_docu_key, header TYPE thead, lines TYPE tlinetab, formatted_text TYPE string, END OF ty_docu_info
2	TY_DOCU_INFO_TAB	Private	See coding			20120215	ty_docu_info_tab TYPE STANDARD TABLE OF ty_docu_info WITH DEFAULT KEY
3	TY_DOCU_KEY	Public	See coding			20120215	BEGIN OF ty_docu_key, id TYPE dokhl-id, object TYPE dokhl-object, textsymbol_1 TYPE string, textsymbol_2 TYPE string, textsymbol_3 TYPE string, textsymbol_4 TYPE string, END OF ty_docu_key
4	TY_HISTORY	Private	See coding			20120215	BEGIN OF ty_history, index TYPE sy-index, END OF ty_history
5	TY_HISTORY_TAB	Private	See coding			20120215	ty_history_tab TYPE STANDARD TABLE OF ty_history WITH DEFAULT KEY

Method Signatures

Method ADD_DOCUMENTATION_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IF_MESSAGE	Call by reference	☑	Object reference (TYPE REF TO)	IF_MESSAGE		Interface for Accessing Texts from Message Objects	20120215
2	Importing	IS_DOCU_OBJECT	Call by reference	☑	Type reference (TYPE)	TY_DOCU_KEY		Documentation Object	20120215
3	Importing	IS_MESSAGE	Call by reference	☑	Type reference (TYPE)	SYMSG		Structure of Message Variables	20120215

Method ADD_DOCUMENTATION_INFO on class CL_CTS_CONFIG_WD_ASSISTANCE has no exception.

Method CHECK_DOCUMETATION_EXISTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_DOCU_EXISTS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		TRUE = The Message has a Long Text	20121017
2	Exporting	EV_DOCU_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SY-LANGU		Language Key	20121017
3	Importing	IS_DOCUMENTATION_OBJECT	Call by reference	☐	Type reference (TYPE)	TY_DOCU_KEY		Documentation Object	20121017

Method CHECK_DOCUMETATION_EXISTS on class CL_CTS_CONFIG_WD_ASSISTANCE has no exception.

Method CHECK_MESSAGE_DOCU_EXISTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_DOCU_EXISTS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		TRUE = The Message has a Long Text	20121017
2	Exporting	EV_DOCU_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SY-LANGU		Language Key	20121017
3	Importing	IV_OBJECTID	Call by reference	☐	Type reference (TYPE)	DOKHL-OBJECT		Documentation Object	20121017

Method CHECK_MESSAGE_DOCU_EXISTS on class CL_CTS_CONFIG_WD_ASSISTANCE has no exception.

Method GET_CURRENT_DOCU_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_DOCU_INFO_REF	Value transfer	☐	Object reference (TYPE REF TO)	TY_DOCU_INFO		Documentation Object Information	20120215

Method GET_CURRENT_DOCU_INFO on class CL_CTS_CONFIG_WD_ASSISTANCE has no exception.

Method GET_DOCUMENTATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_HEADER	Call by reference	☐	Type reference (TYPE)	THEAD		SAP Script - Text Header	20121017
2	Exporting	ET_LINES	Call by reference	☐	Type reference (TYPE)	TLINETAB		Lines of ITF	20121017
3	Importing	IS_DOCUMENTATION_OBJECT	Call by reference	☐	Type reference (TYPE)	TY_DOCU_KEY		Documentation Object	20121017
4	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	LANGU		Language Key	20121017

#	Exception	Resumable	Description	Created on
1	NO_DOCUMENTATION_AVAILABLE	☐	No Documentation available	20120215

Method GET_MESSAGE_DOCUMENTATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_HEADER	Call by reference	☐	Type reference (TYPE)	THEAD		SAP Script - Text Header	20120215
2	Exporting	ET_LINES	Call by reference	☐	Type reference (TYPE)	TLINETAB		Lines of ITF	20120215
3	Importing	IS_MESSAGE	Call by reference	☐	Type reference (TYPE)	SYMSG		Structure of Message Variables	20120215
4	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	LANGU		Language Key	20120215

#	Exception	Resumable	Description	Created on
1	NO_DOCUMENTATION_AVAILABLE	☐	No Documentation available	20120215

Method GET_MESSAGE_FROM_EXCEPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_EXCEPTION	Call by reference	☐	Object reference (TYPE REF TO)	CX_CTS_EXCEPTION		CTS General Exception	20130131
2	Importing	IV_MESSAGE_TYPE	Call by reference	☐	Type reference (TYPE)	SYMSGTY		Message Type	20130131
3	Returning	RS_MESSAGE	Value transfer	☐	Type reference (TYPE)	SYMSG		Structure of Message Variables	20130131

Method GET_MESSAGE_FROM_EXCEPTION on class CL_CTS_CONFIG_WD_ASSISTANCE has no exception.

Method INITIALIZE Signature

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

Method READ_DOCUMENTATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_TEXT	Call by reference	☐	Type reference (TYPE)	STRING		Lines of ITF	20121017

#	Exception	Resumable	Description	Created on
1	NO_DOCUMENTATION_AVAILABLE	☐	No Documentation available	20121017

Method REPLACE_TEXT_SYMBOLS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_LINES	Call by reference	☐	Type reference (TYPE)	TLINETAB		Lines of ITF	20121203
2	Importing	IS_DOCUMENTATION_OBJECT	Call by reference	☐	Type reference (TYPE)	TY_DOCU_KEY		Documentation Object	20121203

Method REPLACE_TEXT_SYMBOLS on class CL_CTS_CONFIG_WD_ASSISTANCE has no exception.

Method SET_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DOCUMENTATION_OBJECT	Call by reference	☐	Type reference (TYPE)	TY_DOCU_KEY		Documentation Object	20121017
2	Importing	IV_LANGUAGE	Call by reference	☑	Type reference (TYPE)	SYLANGU		Language Key	20121017

Method SET_DOCUMENT on class CL_CTS_CONFIG_WD_ASSISTANCE has no exception.

Method SET_LANGUAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	LANGU		Language Key	20120215

Method SET_LANGUAGE on class CL_CTS_CONFIG_WD_ASSISTANCE has no exception.

Method SET_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_LANGUAGE	Call by reference	☑	Type reference (TYPE)	SYLANGU		Language Key	20120215
2	Importing	IV_MSGID	Call by reference	☐	Type reference (TYPE)	SYMSGID		Message Class	20120215
3	Importing	IV_MSGNO	Call by reference	☐	Type reference (TYPE)	SYMSGNO		Message Number	20120215
4	Importing	IV_MSGV1	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message Variable	20120215
5	Importing	IV_MSGV2	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message Variable	20120215
6	Importing	IV_MSGV3	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message Variable	20120215
7	Importing	IV_MSGV4	Call by reference	☑	Type reference (TYPE)	SYMSGV		Message Variable	20120215

Method SET_MESSAGE on class CL_CTS_CONFIG_WD_ASSISTANCE has no exception.

History

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