SAP ABAP Class CL_BSP_DLC_TBUI_PS_TXT_API (Long texts API for TBUI)

Hierarchy

☛ WEBCUIF (Software Component) SAP Web UI Framework
   ⤷ CA-WUI-CON (Application Component) UI Configuration & Design Layer
     ⤷ BSP_DYN_LAYOUT_TB_UI_TOOLS (Package) Guided Activity Page Tools

Properties

Class	CL_BSP_DLC_TBUI_PS_TXT_API
Short Description	Long texts API for TBUI
Super Class
Instantiability of a Class	0	Private
Final	☐

General Data

Message Class
Program status
Category	0
Package	BSP_DYN_LAYOUT_TB_UI_TOOLS	Guided Activity Page Tools
Created	20080401	SAP
Last change	20110908	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_BSP_DLC_TBUI_PS_TXT_API	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_BSP_DLC_TBUI_PS_TXT_API has no interface implemented.

Friends

Class CL_BSP_DLC_TBUI_PS_TXT_API has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_LINE_LENGTH	Constant	Protected	☐	Type reference (TYPE)	INT4	72	Used length of tline-tdline	20080401
2	GC_OBJECT	Constant	Public	☐	Type reference (TYPE)	TROBJTYPE	'TBPS'	Object for CTS	20080830
3	GC_PGMID	Constant	Public	☐	Type reference (TYPE)	PGMID	'R3TR'	Program ID for CTS	20080830
4	GC_PREFIX	Constant	Public	☐	Type reference (TYPE)	CHAR2	'PS'	Prefix defining document kind	20080830
5	GC_STEP_DESCR_ID_OFFSET	Constant	Protected	☐	Type reference (TYPE)	INT4	30	length of prefix	20080426
6	GT_TEXTS	Instance attribute	Private	☐	See coding				20080411
7	GV_CLASSNAME	Instance attribute	Protected	☐	Type reference (TYPE)	SEOCLSNAME		Reference object classname	20080401
8	GV_DEVCLASS	Instance attribute	Protected	☐	Type reference (TYPE)	DEVCLASS		Package	20080401
9	GV_REQUEST	Instance attribute	Protected	☐	Type reference (TYPE)	TRKORR		Transport request used to save the texts	20080401

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Private	Constructor	CONSTRUCTOR	20080401
2	CONVERT_STRING2TABLE	Instance method	Protected	Method	Converting texts from string to tline_tab format	20080401
3	CONVERT_TABLE2STRING	Instance method	Protected	Method	Converting texts from tline_tab format to string	20080401
4	DELETE_PS_TXT_STRING	Instance method	Public	Method	Set one string in the buffer, for deletion	20080411
5	GET_EXISTING_STEP_DESCR_IDS	Instance method	Public	Method	Retrieve existing step descrip. ids for current ref. object	20080403
6	GET_FULL_NAME	Instance method	Public	Method	Retrieves the long text as one string	20080411
7	GET_INSTANCE	Static method	Public	Method	Get an instance of process step text API	20080401
8	GET_PS_TXT_STRING	Instance method	Public	Method	Retrieves the long text as one string	20080401
9	GET_RECORDING_ENTRIES	Instance method	Public	Method	Get transport keys for buffered texts	20080424
10	IS_STEP_DESCR_ID_VALID	Instance method	Public	Method	Check whether is text name is valid	20080425
11	PREPARE_DOC_TABLES	Instance method	Protected	Method	Prepares tables for saving text in doc management	20080401
12	PREPARE_TRANSPORT	Instance method	Protected	Method	Add to transport request if required	20080402
13	SAVE	Instance method	Public	Method	Saves strings which are in the buffer	20080411
14	SET_PS_TXT_STRING	Instance method	Public	Method	Set one string in the buffer, for saving	20080411
15	UPDATE_BUFFER	Instance method	Protected	Method	Set one string in the buffer	20080411

Events

Class CL_BSP_DLC_TBUI_PS_TXT_API has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	BSP_DLCT_TBUI_STEP_DESCR_ID	Public	See coding			20080424	bsp_dlct_tbui_step_descr_id TYPE TABLE OF bsp_dlc_tbui_step_descr_id

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_DEVCLASS	Call by reference	☐	Type reference (TYPE)	DEVCLASS		Pakcage	20080401
2	Importing	IV_REFERENCE_OBJECT	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME		Class name	20080401
3	Importing	IV_REQUEST	Call by reference	☐	Type reference (TYPE)	TRKORR		Request	20080401

Method CONSTRUCTOR on class CL_BSP_DLC_TBUI_PS_TXT_API has no exception.

Method CONVERT_STRING2TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_TEXT_TABLE	Call by reference	☐	Type reference (TYPE)	TLINE_TAB		List of SAPscript Lines	20080401
2	Importing	IV_TEXT_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20080401

Method CONVERT_STRING2TABLE on class CL_BSP_DLC_TBUI_PS_TXT_API has no exception.

Method CONVERT_TABLE2STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_TEXT_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20080401
2	Importing	IT_TEXT_TABLE	Call by reference	☐	Type reference (TYPE)	TLINE_TAB		List of SAPscript Lines	20080401

Method CONVERT_TABLE2STRING on class CL_BSP_DLC_TBUI_PS_TXT_API has no exception.

Method DELETE_PS_TXT_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STEP_DESCRIPTION_ID	Call by reference	☐	Type reference (TYPE)	BSP_DLC_TBUI_STEP_DESCR_ID		Step Description ID	20080411

Method DELETE_PS_TXT_STRING on class CL_BSP_DLC_TBUI_PS_TXT_API has no exception.

Method GET_EXISTING_STEP_DESCR_IDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DESCRIPTION_IDS	Call by reference	☐	Type reference (TYPE)	CL_BSP_DLC_TBUI_PS_TXT_API=>BSP_DLCT_TBUI_STEP_DESCR_ID			20080403

Method GET_EXISTING_STEP_DESCR_IDS on class CL_BSP_DLC_TBUI_PS_TXT_API has no exception.

Method GET_FULL_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STEP_DESCRIPTION_ID	Call by reference	☐	Type reference (TYPE)	BSP_DLC_TBUI_STEP_DESCR_ID		Step Description ID	20080411
2	Returning	RV_FULL_NAME	Value transfer	☐	Type reference (TYPE)	STRING		Full (prefixed) name of long text	20080411

Method GET_FULL_NAME on class CL_BSP_DLC_TBUI_PS_TXT_API has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REFERENCE_OBJECT	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME		Object Type Name	20080401
2	Importing	IV_REQUEST	Call by reference	☑	Type reference (TYPE)	TRKORR		Request for text save	20080401
3	Returning	RR_API	Value transfer	☐	Object reference (TYPE REF TO)	CL_BSP_DLC_TBUI_PS_TXT_API		Long texts API for TBUI	20080401

#	Exception	Resumable	Description	Created on
1	INVALID_REFERENCE_OBJECT	☐	Reference object doesn't correspond to existing class name	20080401

Method GET_PS_TXT_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_TEXT_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20080401
2	Importing	IV_STEP_DESCRIPTION_ID	Call by reference	☐	Type reference (TYPE)	BSP_DLC_TBUI_STEP_DESCR_ID		Step Description ID	20080403

#	Exception	Resumable	Description	Created on
1	MARKED_FOR_DELETION	☐	Text is in the buffer and marked for deletion	20080412
2	NOT_FOUND	☐	Text not found	20080401

Method GET_RECORDING_ENTRIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RECORDING_ENTRIES	Call by reference	☐	Type reference (TYPE)	CTS_RECORDING_ENTRIES		WBO Remote API: Entries for Change Recording	20080424

Method GET_RECORDING_ENTRIES on class CL_BSP_DLC_TBUI_PS_TXT_API has no exception.

Method IS_STEP_DESCR_ID_VALID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STEP_DESCR_ID	Call by reference	☐	Type reference (TYPE)	BSP_DLC_TBUI_STEP_DESCR_ID		Step Description ID	20080425
2	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20080425

Method IS_STEP_DESCR_ID_VALID on class CL_BSP_DLC_TBUI_PS_TXT_API has no exception.

Method PREPARE_DOC_TABLES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_DOKHL	Call by reference	☐	Type reference (TYPE)	DOKHL		Header for Documentation Table DOKH	20080401
2	Exporting	ES_DOKIL	Call by reference	☐	Type reference (TYPE)	DOKIL		Index for Documentation Table DOKH	20080401
3	Importing	IT_TEXT_TABLE	Call by reference	☐	Type reference (TYPE)	TLINE_TAB		List of SAPscript Lines	20080401
4	Importing	IV_FULL_NAME	Call by reference	☐	Type reference (TYPE)	DOKU_OBJ		Documentation Object	20080401

Method PREPARE_DOC_TABLES on class CL_BSP_DLC_TBUI_PS_TXT_API has no exception.

Method PREPARE_TRANSPORT Signature

Method PREPARE_TRANSPORT on class CL_BSP_DLC_TBUI_PS_TXT_API has no parameter.

#	Exception	Resumable	Description	Created on
1	SAVE_IMPOSSIBLE	☐	Transport problems => save is impossible	20080402

Method SAVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REQUEST	Call by reference	☑	Type reference (TYPE)	TRKORR		Request for text save	20080411

#	Exception	Resumable	Description	Created on
1	SAVE_FAILED	☐	Saving of one or more texts failed	20080411

Method SET_PS_TXT_STRING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STEP_DESCRIPTION_ID	Call by reference	☐	Type reference (TYPE)	BSP_DLC_TBUI_STEP_DESCR_ID		Step Description ID	20080411
2	Importing	IV_TEXT_STRING	Call by reference	☐	Type reference (TYPE)	STRING			20080411

#	Exception	Resumable	Description	Created on
1	STEP_DESCR_ID_NOT_VALID	☐	Invalid ID for step description text	20080426

Method UPDATE_BUFFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_MARK_FOR_DELETION	Call by reference	☐	Type reference (TYPE)	CHAR1		Single-Character Flag	20080411
2	Importing	IV_STEP_DESCRIPTION_ID	Call by reference	☐	Type reference (TYPE)	BSP_DLC_TBUI_STEP_DESCR_ID		Step Description ID	20080411
3	Importing	IV_TEXT_STRING	Call by reference	☐	Type reference (TYPE)	STRING		Value of the long text	20080411

Method UPDATE_BUFFER on class CL_BSP_DLC_TBUI_PS_TXT_API has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	700