SAP ABAP Interface IF_GUI_VIEWER_CONSUMER_MODEL (Consumer Model Interface for SAP 3D VE Viewer in SAP GUI)
Hierarchy
SAP_BS_FND (Software Component) SAP Business Suite Foundation
   CA-EPT-VE-VEV (Application Component) Visual Enterprise Viewer
     VISUAL_ENTERPRISE_VIEWER (Package) Visual Enterprise Viewer
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  CL_GUI_VIEWER_MODEL Model Class to Load SAP 3D VE Viewer in SAP GUI 20121012
Properties
Interface IF_GUI_VIEWER_CONSUMER_MODEL  
Short Description Consumer Model Interface for SAP 3D VE Viewer in SAP GUI    
General Data
Package VISUAL_ENTERPRISE_VIEWER   Visual Enterprise Viewer 
Created 20121012   SAP 
Last changed 20140121   SAP 
Unicode checks active    
Forward declarations
Interface IF_GUI_VIEWER_CONSUMER_MODEL has no forward declaration.
Interfaces
Interface IF_GUI_VIEWER_CONSUMER_MODEL has no interface.
Friends
Interface IF_GUI_VIEWER_CONSUMER_MODEL has no friend.
Attributes
Interface IF_GUI_VIEWER_CONSUMER_MODEL has no attribute.
Methods
# Method Level Visibility Method type Description Created on
1 ADD_ITEMS Instance method Public Method add additional items 20130114
2 FREE Instance method Public Method Destructor 20121016
3 LOAD_ASSEMBLY Instance method Public Method Load assembly in SAP VE Viewer 20121213
4 LOAD_VIEWER Instance method Public Method Load VE Viewer in SAP GUI 20121012
5 PAINT_PARTS Instance method Public Method Paint parts in Viewable file 20130920
6 REMOVE_PART Instance method Public Method Remove item from viewable file 20121224
7 REQUEST_METADATA Instance method Public Method Request metadata from VE Viewer 20121012
8 REQUEST_STEP_PROPERTIES Instance method Public Method Request for steps and properties of viewable files 20121119
9 SAVE_CHANGED_LAYER Instance method Public Method Save Changed layers of viewable file 20121114
10 SET_METADATA Instance method Public Method Set metadata in viewable file 20121224
11 SET_VISUALIZATION Instance method Public Method Visualized a part in viewable file 20121114
12 SET_ZOOM Instance method Public Method Zoom particular part in viewble 20130125
Events
# Event Type Visibility Description Created on
1 SAP_ACTION Instance Event
(0)
Public
(2)
Event to inform consumer that source application event fired 20121012
2 SAP_LOAD_DONE Instance Event
(0)
Public
(2)
Event to inform viewer loaded or not 20121107
3 SAP_METADATA Instance Event
(0)
Public
(2)
Event to provide metadata information 20121012
4 SAP_REMOVE Instance Event
(0)
Public
(2)
Event to inform part is removed 20121224
5 SAP_SAVE_LAYER_DONE Instance Event
(0)
Public
(2)
Event to inform layers are save 20121107
6 SAP_SET_LAYER_CHANGE Instance Event
(0)
Public
(2)
Event to inform layers are changed 20121107
7 SAP_STEP_PROPERTIES Instance Event
(0)
Public
(2)
Event to provide step properties information 20121119
8 SAP_VISUALIZATION Instance Event
(0)
Public
(2)
Event to inform part selected 20121012
9 VWR_MESSAGE Instance Event
(0)
Public
(2)
Event to inform error/success msg while executing dispatch 20121015
Types
Interface IF_GUI_VIEWER_CONSUMER_MODEL has no local type.
Method Signatures

Method ADD_ITEMS 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) VEVWR_T_MSG Messages to be passed to consumer 20130114
2 Importing IT_BOUNDINGBOX Call by reference Type reference (TYPE) /PLMU/T_VWR_BOUNDINGBOX_ID Tabletype of /PLMU/S_VWR_BOUNDINGBOX_ID 20130114
3 Importing IT_ITEMS Call by reference Type reference (TYPE) /PLMU/T_VWR_ADD_ITEM Tabletype of /PLMU/S_VWR_ADD_ITEM 20130114
4 Importing IT_METADATA Call by reference Type reference (TYPE) /PLMU/T_VWR_METADATA Tabletype of /PLMB/S_VWR_METADATA 20130114
5 Importing IT_TRAFO Call by reference Type reference (TYPE) /PLMU/T_VWR_TRAFO_ID Tabletype of /PLMU/S_VWR_TRAFO_ID 20130114

Method ADD_ITEMS on Interface IF_GUI_VIEWER_CONSUMER_MODEL has no exception.

Method FREE Signature

Method FREE on Interface IF_GUI_VIEWER_CONSUMER_MODEL has no parameter.
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 20130110
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 20130110

Method LOAD_ASSEMBLY 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) VEVWR_T_MSG Messages to be passed to consumer 20130102
2 Importing IO_PARENT Call by reference Object reference (TYPE REF TO) CL_GUI_OBJECT Proxy Class for a GUI Object 20130110
3 Importing IS_HIDE_HIGHLIGHT Call by reference Type reference (TYPE) /PLMU/S_VWR_HIDE_HIGHLIGHT Structure for visualization 20130102
4 Importing IS_ROOT Call by reference Type reference (TYPE) /PLMU/S_VWR_ROOT Structure for root element 20130102
5 Importing IT_ACTIONS Call by reference Type reference (TYPE) /PLMU/T_VWR_ACTION table of actions 20130102
6 Importing IT_BOUNDINGBOX Call by reference Type reference (TYPE) /PLMU/T_VWR_BOUNDINGBOX_ID Tabletype of /PLMU/S_VWR_BOUNDINGBOX_ID 20130102
7 Importing IT_EXCLACTION Call by reference Type reference (TYPE) /PLMU/T_VWR_EXCLACTION Viewer actions not allowed 20130102
8 Importing IT_METADATA Call by reference Type reference (TYPE) /PLMU/T_VWR_METADATA Tabletype of /PLMB/S_VWR_METADATA 20130102
9 Importing IT_SUBPARTS Call by reference Type reference (TYPE) /PLMU/T_VWR_SUBPART Tabletype of /PLMU/S_VWR_SUBPART 20130102
10 Importing IT_TRAFO Call by reference Type reference (TYPE) /PLMU/T_VWR_TRAFO_ID Tabletype of /PLMU/S_VWR_TRAFO_ID 20130102
11 Importing IV_ID_FIELD Call by reference Type reference (TYPE) /PLMU/VWR_ID_FIELD ID Field in the Viewer 20130102

Method LOAD_ASSEMBLY on Interface IF_GUI_VIEWER_CONSUMER_MODEL has no exception.

Method LOAD_VIEWER 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) VEVWR_T_MSG Messages to be passed to consumer 20121015
2 Importing IO_PARENT Call by reference Object reference (TYPE REF TO) CL_GUI_OBJECT Proxy Class for a GUI Object 20121012
3 Importing IT_ACTIONS Call by reference Type reference (TYPE) /PLMU/T_VWR_ACTION table of actions 20121012
4 Importing IT_EXCLUDE_ACTION Call by reference Type reference (TYPE) /PLMU/T_VWR_EXCLACTION Viewer actions not allowed 20121012
5 Importing IT_LAYER_LIST Call by reference Type reference (TYPE) /PLMU/T_VWR_LAYERDATA Tabletype of /PLMU/S_VWR_LAYERDATA 20121012
6 Importing IV_CREATE_LAYER Call by reference Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20121012
7 Importing IV_DEACTIVATE_REDLINING Call by reference Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20121012
8 Importing IV_DISPLAY_ALL_MARKUPS Call by reference Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20121012
9 Importing IV_FILEPATH Call by reference Type reference (TYPE) STRING Viewable file path 20121012
10 Importing IV_ID_FIELD Call by reference Type reference (TYPE) /PLMU/VWR_ID_FIELD ID Field in the Viewer 20121012
11 Importing IV_NAME Call by reference Type reference (TYPE) /PLMU/VWR_NAME Name for an Element in the Viewer 20121012
12 Importing IV_POSID Call by reference Type reference (TYPE) /PLMU/VWR_GUID GUID for Viewer 20130110
13 Importing IV_VISUALIZATION Call by reference Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20121012
14 Importing IV_VISUAL_INDEX Call by reference Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20121012

Method LOAD_VIEWER on Interface IF_GUI_VIEWER_CONSUMER_MODEL has no exception.

Method PAINT_PARTS 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) VEVWR_T_MSG Messages to be passed to consumer 20130920
2 Importing IT_PAINT_LIST Call by reference Type reference (TYPE) VEVWR_T_PAINT_LIST VE Viewer Paint List 20130920

Method PAINT_PARTS on Interface IF_GUI_VIEWER_CONSUMER_MODEL has no exception.

Method REMOVE_PART 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) VEVWR_T_MSG Messages to be passed to consumer 20121224
2 Importing IT_REMOVE_ITEM Call by reference Type reference (TYPE) /PLMU/T_VWR_REMOVE Table Type of Structure /PLMU/S_VWR_REMOVE 20121224

Method REMOVE_PART on Interface IF_GUI_VIEWER_CONSUMER_MODEL has no exception.

Method REQUEST_METADATA 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) VEVWR_T_MSG Messages to be passed to consumer 20121015

Method REQUEST_METADATA on Interface IF_GUI_VIEWER_CONSUMER_MODEL has no exception.

Method REQUEST_STEP_PROPERTIES 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) VEVWR_T_MSG Messages to be passed to consumer 20121119

Method REQUEST_STEP_PROPERTIES on Interface IF_GUI_VIEWER_CONSUMER_MODEL has no exception.

Method SAVE_CHANGED_LAYER 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) VEVWR_T_MSG Messages to be passed to consumer 20121114

Method SAVE_CHANGED_LAYER on Interface IF_GUI_VIEWER_CONSUMER_MODEL has no exception.

Method SET_METADATA 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) VEVWR_T_MSG Messages to be passed to consumer 20121224
2 Importing IT_METADATA Call by reference Type reference (TYPE) /PLMU/T_VWR_METADATA Tabletype of /PLMB/S_VWR_METADATA 20121224

Method SET_METADATA on Interface IF_GUI_VIEWER_CONSUMER_MODEL has no exception.

Method SET_VISUALIZATION 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) VEVWR_T_MSG Messages to be passed to consumer 20121114
2 Importing IT_VISUALIZATION Call by reference Type reference (TYPE) /PLMU/T_VWR_VISUALIZATION Tabletype of /PLMU/S_VWR_VISUALIZATION 20121114

Method SET_VISUALIZATION on Interface IF_GUI_VIEWER_CONSUMER_MODEL has no exception.

Method SET_ZOOM 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) VEVWR_T_MSG Messages to be passed to consumer 20130125
2 Importing IT_SET_ZOOM Call by reference Type reference (TYPE) VEVWR_T_SET_ZOOM Parts which we need to zoom in viewer 20130125

Method SET_ZOOM on Interface IF_GUI_VIEWER_CONSUMER_MODEL has no exception.
Event Signatures

Event SAP_ACTION Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 IT_ACTION Exporting Value transfer Type reference (TYPE) /PLMU/T_VWR_ACTREQUEST Tabletype of /PLMU/S_VWR_ACTREQUEST 20121012

Event SAP_LOAD_DONE Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 IV_LOAD_DONE Exporting Value transfer Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20121107

Event SAP_METADATA Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 IT_METADATA Exporting Value transfer Type reference (TYPE) /PLMU/T_VWR_METADATA Tabletype of /PLMB/S_VWR_METADATA 20121012

Event SAP_REMOVE Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 IV_REMOVE Exporting Value transfer Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20121224

Event SAP_SAVE_LAYER_DONE Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 IT_SAVE_LAYER_DONE Exporting Value transfer Type reference (TYPE) /PLMU/T_VWR_SAVE_LAYER_DONE Tabletype of /PLMU/S_VWR_SAVE_LAYER_DONE 20121107

Event SAP_SET_LAYER_CHANGE Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 IV_SET_LAYER_CHANGE Exporting Value transfer Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20121107

Event SAP_STEP_PROPERTIES Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 IT_STEP_PROPERTIES Exporting Value transfer Type reference (TYPE) VEVWR_T_STEP_PROPERTIES Visual Enterprise Viewer step properties 20121213

Event SAP_VISUALIZATION Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 IV_VISUALIZATION_FLAG Exporting Value transfer Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20121012

Event VWR_MESSAGE Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 IT_MESSAGE Exporting Value transfer Type reference (TYPE) VEVWR_T_MSG Messages to be passed to consumer 20121015
History
Last changed by/on SAP  20140121 
SAP Release Created in 747