SAP ABAP Class CL_TMS_DOCFLOW_UI (UI Class to display TM Document Flow)

Hierarchy

☛ SAP_APPL (Software Component) Logistics and Accounting
   ⤷ LO-INT-TM (Application Component) Transportation Management Integration
     ⤷ INT_TM_ERP_BASICS (Package) ERP - Ext. TMS Order Integration: Basic Functions

Properties

Class	CL_TMS_DOCFLOW_UI
Short Description	UI Class to display TM Document Flow
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	INT_TM_ERP_BASICS	ERP - Ext. TMS Order Integration: Basic Functions
Created	20111103	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_TMS_DOCFLOW_UI has no forward declaration.

Interfaces

Class CL_TMS_DOCFLOW_UI has no interface implemented.

Friends

Class CL_TMS_DOCFLOW_UI has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MR_TREE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_ALV_TREE			20111103
2	MT_DOCFLOW_DATA	Instance attribute	Private	☐	Type reference (TYPE)	TMS_T_DOC_FLOW_SCR		TM-ERP-Integration: Document flow hierarchy on the UI	20111103
3	MT_EXPAND_NODES	Instance attribute	Private	☐	Type reference (TYPE)	LVC_T_NKEY			20111103
4	MT_GUID_NODES	Instance attribute	Private	☐	Type reference (TYPE)	LTT_GUID_NODES			20111103
5	MT_OUTTAB	Instance attribute	Private	☐	Type reference (TYPE)	TMS_T_DOC_FLOW_SCR		TM-ERP-Integration: Document flow hierarchy on the UI	20111103
6	MT_TREE_FCAT	Instance attribute	Private	☐	Type reference (TYPE)	LVC_T_FCAT			20111103
7	MV_ALL_DEPENDENCIES	Instance attribute	Private	☐	Type reference (TYPE)	XFELD		flag, whether to show all dependencies of HU to packages	20120430
8	MV_DOC_ITEM	Instance attribute	Private	☐	Type reference (TYPE)	TMS_DOC_ITEM		TM-ERP-Integration: Document Item	20111110
9	MV_DOC_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	TMS_DOC_TYPE		Document Type	20120430
10	MV_FIRST_NODE	Instance attribute	Private	☐	Type reference (TYPE)	LVC_NKEY		ALV Tree Control: Node Key	20111128
11	MV_FU_EXIST	Instance attribute	Private	☐	Type reference (TYPE)	XFELD		flag, whether Freight units exist	20120430
12	MV_HU_EXIST	Instance attribute	Private	☐	Type reference (TYPE)	XFELD		flag, whether data set contains Handling Units	20111206
13	MV_ICON_STATUS	Instance attribute	Private	☐	Type reference (TYPE)	TMS_DOCUMENT_ICON		Document Icon	20111114
14	MV_SHOW_FU_ITEMS	Instance attribute	Private	☐	Type reference (TYPE)	XFELD		flag, whether to display FU Items	20120430
15	MV_VIEW	Instance attribute	Private	☐	Type reference (TYPE)	CHAR1		'1'-ERP View; '2'-TM View	20111110

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_NODE	Instance method	Private	Method	Add Tree node	20111103
2	CONSTRUCTOR	Instance method	Public	Constructor		20111103
3	DISPLAY_DOC_STATUS	Instance method	Private	Method	Display Document Status Table	20111115
4	DISPLAY_ERP_DOCUMENT	Instance method	Private	Method	Display ERP Document	20111114
5	DISPLAY_TM_DOCUMENT	Instance method	Private	Method	Display TM Document	20111114
6	DOCFLOW_TREE_FILL_DATA	Instance method	Private	Method	Fill document tree with data	20111103
7	FILL_HDR_SCREEN	Instance method	Public	Method	Fill Header Status Data	20111103
8	FILL_ITEM_SCREEN	Instance method	Public	Method	Fill Item Status Data	20111103
9	FILL_NODE_ICON	Static method	Private	Method	Fill icon for executed step	20111103
10	FILL_TM_STATUS	Instance method	Private	Method	Fill SD Item Data	20111103
11	GET_CONTEXT_TEXT	Instance method	Private	Method	Get Text for context Menue	20111109
12	GET_GUID_NODE	Instance method	Private	Method	get tree node from GUID	20111103
13	GET_NODE_TEXT	Instance method	Private	Method	Get node text for tree	20111108
14	GET_TREE_FCAT	Instance method	Private	Method	set field catalogue for tree	20111103
15	GET_VIEW_TYPE	Instance method	Public	Method	Get current View Type	20111110
16	INITIALIZE	Instance method	Public	Method	Set display data	20111114
17	ON_CONTEXT_MENU_REQ	Instance method	Private	Event handling method	request context menue	20111108
18	ON_CONTEXT_MENU_SELECT	Instance method	Private	Event handling method	Select Entry from Context Menue	20111108
19	ON_FUNCTION_SELECTED	Instance method	Private	Event handling method	Execute Tree Toolbar Functions	20111110
20	ON_ITEM_DOUBLE_CLICK	Instance method	Private	Event handling method	item double click	20111103
21	ON_LINK_CLICK	Instance method	Private	Event handling method	Link to documents	20111103
22	SETUP_TREE	Instance method	Public	Method	setup tree for initial display	20111103
23	SET_DATA_FOR_DISPLAY	Instance method	Public	Method	Set display data	20111110
24	SET_EVENTS	Instance method	Private	Method	set-up events for tree	20111103
25	SET_EXPAND_NODE	Instance method	Private	Method	get tree node from GUID	20111103
26	SET_GUID_NODE	Instance method	Private	Method	Set node_id to Guid	20111103
27	SET_TOOLBAR	Instance method	Private	Method	Set Toolbar Functions for Tree	20111110
28	SHOW_LEVEL	Instance method	Private	Method	Check if this hierarchy level of a freight docuemnt is to be	20120430

Events

Class CL_TMS_DOCFLOW_UI has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	LTS_GUID_NODE	Private	See coding			20111103	BEGIN OF lts_guid_node, guid TYPE c LENGTH 32, parent TYPE salv_de_node_key, node TYPE salv_de_node_key, END OF lts_guid_node
2	LTT_GUID_NODES	Private	See coding			20111103	ltt_guid_nodes TYPE STANDARD TABLE OF lts_guid_node

Method Signatures

Method ADD_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_NODE	Call by reference	☐	Type reference (TYPE)	LVC_NKEY			20111103
2	Importing	IS_DOCFLOW	Call by reference	☐	Type reference (TYPE)	TMS_S_DOC_FLOW_SCR		TM-ERP-Integration: Document flow hierarchy on the UI	20111103
3	Importing	IV_PARENT_NODE	Call by reference	☐	Type reference (TYPE)	LVC_NKEY			20111103

Method ADD_NODE on class CL_TMS_DOCFLOW_UI has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_DOCFLOW_DATA	Call by reference	☐	Type reference (TYPE)	TMS_T_DOC_FLOW_SCR		TM-ERP-Integration: Document flow hierarchy on the UI	20111103
2	Importing	IV_DOC_ITEM	Call by reference	☑	Type reference (TYPE)	TMS_DOC_ITEM		TM-ERP-Integration: Document Item	20111110
3	Importing	IV_DOC_TYPE	Call by reference	☐	Type reference (TYPE)	TMS_DOC_TYPE		Document Type	20120430
4	Importing	IV_VIEW	Call by reference	☐	Type reference (TYPE)	CHAR1		'1'-ERP View; '2'-TM View	20111110

Method CONSTRUCTOR on class CL_TMS_DOCFLOW_UI has no exception.

Method DISPLAY_DOC_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_LINE	Call by reference	☐	Type reference (TYPE)	TMS_S_DOC_FLOW_SCR		TM-ERP-Integration: Document flow hierarchy on the UI	20111115
2	Importing	IV_NODE_TEXT	Call by reference	☐	Type reference (TYPE)	LVC_VALUE		ALV Control: Cell Content	20111115

Method DISPLAY_DOC_STATUS on class CL_TMS_DOCFLOW_UI has no exception.

Method DISPLAY_ERP_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_LINE	Call by reference	☐	Type reference (TYPE)	TMS_S_DOC_FLOW_SCR		TM-ERP-Integration: Document flow hierarchy on the UI	20111114

Method DISPLAY_ERP_DOCUMENT on class CL_TMS_DOCFLOW_UI has no exception.

Method DISPLAY_TM_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_LINE	Call by reference	☐	Type reference (TYPE)	TMS_S_DOC_FLOW_SCR		TM-ERP-Integration: Document flow hierarchy on the UI	20111114

Method DISPLAY_TM_DOCUMENT on class CL_TMS_DOCFLOW_UI has no exception.

Method DOCFLOW_TREE_FILL_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_TREE	Call by reference	☑	Object reference (TYPE REF TO)	CL_GUI_ALV_TREE			20111103

Method DOCFLOW_TREE_FILL_DATA on class CL_TMS_DOCFLOW_UI has no exception.

Method FILL_HDR_SCREEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_ITEM	Value transfer	☐	Type reference (TYPE)	TMS_S_DOC_STATUS_SCR		TM-ERP-Integration: Document Status structure for screen	20111103

Method FILL_HDR_SCREEN on class CL_TMS_DOCFLOW_UI has no exception.

Method FILL_ITEM_SCREEN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_ITEM	Value transfer	☐	Type reference (TYPE)	TMS_S_DOC_STATUS_SCR		TM-ERP-Integration: Document Status structure for screen	20111103

Method FILL_ITEM_SCREEN on class CL_TMS_DOCFLOW_UI has no exception.

Method FILL_NODE_ICON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ICON	Call by reference	☐	Type reference (TYPE)	TMS_DOCUMENT_ICON		Document Icon	20111103
2	Importing	IV_BTD_CAT	Call by reference	☐	Type reference (TYPE)	TMS_BTD_CATEGORY_CODE		Business Document Category Code	20111104
3	Importing	IV_ICON_TEXT	Call by reference	☐	Type reference (TYPE)	TV_IMAGE		Tree Control: Icon / Image	20111103
4	Importing	IV_ITEM_CAT	Call by reference	☐	Type reference (TYPE)	TMS_ITEM_CATEGORY_CODE		Business Document Item Category Code	20111104

Method FILL_NODE_ICON on class CL_TMS_DOCFLOW_UI has no exception.

Method FILL_TM_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_STATUS	Call by reference	☐	Type reference (TYPE)	TMS_T_TM_STATUS		Table of generic business transaction values	20111103
2	Returning	RS_STATUS	Value transfer	☐	Type reference (TYPE)	TMS_S_DOC_STATUS		TM-ERP-Integration: Document Status Values	20111103

Method FILL_TM_STATUS on class CL_TMS_DOCFLOW_UI has no exception.

Method GET_CONTEXT_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ERP_TEXT	Call by reference	☐	Type reference (TYPE)	GUI_TEXT		Menu Painter: Function or menu text (4.0)	20111109
2	Exporting	EV_TM_TEXT	Call by reference	☐	Type reference (TYPE)	GUI_TEXT		Menu Painter: Function or menu text (4.0)	20111109
3	Importing	IS_DOCFLOW	Call by reference	☐	Type reference (TYPE)	TMS_S_DOC_FLOW_SCR		TM-ERP-Integration: Document flow hierarchy on the UI	20111109

Method GET_CONTEXT_TEXT on class CL_TMS_DOCFLOW_UI has no exception.

Method GET_GUID_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_GUID	Call by reference	☐	Type reference (TYPE)	TMS_GUID		TM-ERP Integration: Guid for TM Objects	20111103
2	Returning	RV_NODE	Value transfer	☐	Type reference (TYPE)	LVC_NKEY			20111103

Method GET_GUID_NODE on class CL_TMS_DOCFLOW_UI has no exception.

Method GET_NODE_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BTD_CAT	Call by reference	☐	Type reference (TYPE)	TMS_BTD_CATEGORY_CODE		Business Document Category Code	20111108
2	Importing	IV_DOC_TYPE	Call by reference	☐	Type reference (TYPE)	TMS_DOC_TYPE		Document Type	20111108
3	Importing	IV_ITEM_CAT	Call by reference	☐	Type reference (TYPE)	TMS_ITEM_CATEGORY_CODE		Business Document Item Category Code	20111108
4	Returning	RV_NODE_TEXT	Value transfer	☐	Type reference (TYPE)	LVC_VALUE			20111108

Method GET_NODE_TEXT on class CL_TMS_DOCFLOW_UI has no exception.

Method GET_TREE_FCAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_FCAT	Value transfer	☐	Type reference (TYPE)	LVC_T_FCAT			20111103

Method GET_TREE_FCAT on class CL_TMS_DOCFLOW_UI has no exception.

Method GET_VIEW_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ALL_LEVELS	Call by reference	☐	Type reference (TYPE)	XFELD		checkbox	20120430
2	Exporting	EV_SHOW_FU_ITEMS	Call by reference	☐	Type reference (TYPE)	XFELD		Checkbox	20120430
3	Exporting	EV_VIEW_TYPE	Call by reference	☐	Type reference (TYPE)	CHAR1		Single-Character Indicator	20120430

Method GET_VIEW_TYPE on class CL_TMS_DOCFLOW_UI has no exception.

Method INITIALIZE Signature

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

Method ON_CONTEXT_MENU_REQ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FIELDNAME	Call by reference	☐	Attribute reference (LIKE)				20111108
2	Importing	MENU	Call by reference	☐	Attribute reference (LIKE)				20111108
3	Importing	NODE_KEY	Call by reference	☐	Attribute reference (LIKE)				20111108

Method ON_CONTEXT_MENU_REQ on class CL_TMS_DOCFLOW_UI has no exception.

Method ON_CONTEXT_MENU_SELECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FCODE	Call by reference	☐	Attribute reference (LIKE)				20111108
2	Importing	FIELDNAME	Call by reference	☐	Attribute reference (LIKE)				20111108
3	Importing	NODE_KEY	Call by reference	☐	Attribute reference (LIKE)				20111108

Method ON_CONTEXT_MENU_SELECT on class CL_TMS_DOCFLOW_UI has no exception.

Method ON_FUNCTION_SELECTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FCODE	Call by reference	☐	Attribute reference (LIKE)				20111110

Method ON_FUNCTION_SELECTED on class CL_TMS_DOCFLOW_UI has no exception.

Method ON_ITEM_DOUBLE_CLICK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE_KEY	Value transfer	☐	Attribute reference (LIKE)				20111103

Method ON_ITEM_DOUBLE_CLICK on class CL_TMS_DOCFLOW_UI has no exception.

Method ON_LINK_CLICK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FIELDNAME	Value transfer	☐	Attribute reference (LIKE)				20111103
2	Importing	NODE_KEY	Value transfer	☐	Attribute reference (LIKE)				20111103

Method ON_LINK_CLICK on class CL_TMS_DOCFLOW_UI has no exception.

Method SETUP_TREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_TREE	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_ALV_TREE			20111103

Method SETUP_TREE on class CL_TMS_DOCFLOW_UI has no exception.

Method SET_DATA_FOR_DISPLAY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_DOCFLOW_DATA	Call by reference	☐	Type reference (TYPE)	TMS_T_DOC_FLOW_SCR		TM-ERP-Integration: Document flow hierarchy on the UI	20111110

Method SET_DATA_FOR_DISPLAY on class CL_TMS_DOCFLOW_UI has no exception.

Method SET_EVENTS Signature

Method SET_EVENTS on class CL_TMS_DOCFLOW_UI has no parameter.
Method SET_EVENTS on class CL_TMS_DOCFLOW_UI has no exception.

Method SET_EXPAND_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_NODE	Call by reference	☐	Type reference (TYPE)	LVC_NKEY			20111103

Method SET_EXPAND_NODE on class CL_TMS_DOCFLOW_UI has no exception.

Method SET_GUID_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_GUID	Call by reference	☐	Type reference (TYPE)	TMS_GUID		TM-ERP Integration: Guid for TM Objects	20111103
2	Importing	IV_NODE	Call by reference	☐	Type reference (TYPE)	LVC_NKEY			20111103
3	Importing	IV_PARENT	Call by reference	☐	Type reference (TYPE)	LVC_NKEY			20111103

Method SET_GUID_NODE on class CL_TMS_DOCFLOW_UI has no exception.

Method SET_TOOLBAR Signature

Method SET_TOOLBAR on class CL_TMS_DOCFLOW_UI has no parameter.
Method SET_TOOLBAR on class CL_TMS_DOCFLOW_UI has no exception.

Method SHOW_LEVEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_DOCFLOW	Call by reference	☐	Type reference (TYPE)	TMS_S_DOC_FLOW_SCR		TM-ERP-Integration: Document flow hierarchy on the UI	20120430
2	Returning	RV_SHOW	Value transfer	☐	Type reference (TYPE)	XFELD		'X'-show level	20120430

Method SHOW_LEVEL on class CL_TMS_DOCFLOW_UI has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	606