SAP ABAP Class CL_CHIP_PORT_HELPER (Help Classes for Creating Ports)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-WD-ABA-PB (Application Component) WD ABAP Page Builder
     ⤷ SWDP_CCP_API (Package) Web Dynpro ABAP: CCP Integration API

Properties

Class	CL_CHIP_PORT_HELPER
Short Description	Help Classes for Creating Ports
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SWDP_CCP_API	Web Dynpro ABAP: CCP Integration API
Created	20081103	SAP
Last change	20130531	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

Class CL_CHIP_PORT_HELPER has no interface implemented.

Friends

Class CL_CHIP_PORT_HELPER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CLASS_OF_EVENT_DATA	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_ABAP_OBJECTDESCR		Type of CL_CHIP_PORT_EVENT_DATA	20081216
2	CLASS_OF_PORT_DESCRIPTION	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_ABAP_OBJECTDESCR		Runtime Type Services	20100127
3	PARAMETER_USAGE_NOT	Constant	Public	☐	Type reference (TYPE)	CHIP_PARAMETER_USAGE_INFO	'-'	Field not used as an optional parameter	20081104
4	PARAMETER_USAGE_OPTIONAL	Constant	Public	☐	Type reference (TYPE)	CHIP_PARAMETER_USAGE_INFO	' '	Field used as an optional parameter	20081104
5	PARAMETER_USAGE_REQUIRED	Constant	Public	☐	Type reference (TYPE)	CHIP_PARAMETER_USAGE_INFO	'X'	Field used as a mandatory parameter	20081104

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CAST_PORT_EVENT	Static method	Public	Method	Attempts a down-cast for a port event	20081216
2	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20081216
3	COPY_PORT_DESCRIPTION	Static method	Public	Method		20100105
4	CREATE_PARAMETER_DESCRIPTION	Static method	Public	Method	Creates a parameter description from type information	20081104
5	CREATE_PORT_DESCRIPTION	Static method	Public	Method	Creates a port description from type information	20081103
6	CREATE_PORT_DESCRIPTION_INT	Static method	Private	Method	Internal Implementation	20081110
7	CREATE_PORT_DESCR_FROM_DDIC	Static method	Public	Method	Creats a port description from DDIC information	20081104
8	CREATE_PORT_DESCR_FROM_RTTI	Static method	Public	Method	Creates a port description from RTTI information	20081223
9	CREATE_PORT_EVENT_FROM_DATA	Static method	Public	Method	Creates a port event from data	20081216
10	GET_DATA_FROM_PORT_EVENT	Static method	Public	Method	Converts a port event into ABAP data	20081216
11	GET_PARAMETERS_FROM_RTTI	Static method	Private	Method	Creates a parameter description from RTTI	20081223
12	GET_PORTS_WITH_PARAMETERS	Static method	Public	Method		20101110
13	GET_PORT_DESCRIPTION	Static method	Public	Method	Provides port description of a port	20081121
14	GET_PORT_DESCRIPTION_VERSION	Static method	Public	Method		20100528
15	GET_PORT_DESCRIPTION_XML	Static method	Public	Method		20100528
16	GET_PORT_TYPE	Static method	Public	Method		20101125
17	IS_VALID_PORT_EVENT	Static method	Public	Method		20110810
18	PORT_HAS_PARAMETERS	Static method	Public	Method		20101110

Events

Class CL_CHIP_PORT_HELPER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	PARAMETER_DESCRIPTION	Public	See coding			20081103	begin of PARAMETER_DESCRIPTION, name type string, display_name type string, description type string, typedescr type ref to cl_abap_elemdescr, is_required type wdy_boolean, tagging_info type chip_tagging_infos, end of PARAMETER_DESCRIPTION
2	PARAMETER_DESCRIPTIONS	Public	See coding			20081103	PARAMETER_DESCRIPTIONS type hashed table of PARAMETER_DESCRIPTION with unique key name

Method Signatures

Method CAST_PORT_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PORT_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_CHIP_PORT_EVENT		CHIP Port Event	20081216
2	Returning	PORT_EVENT_DATA	Value transfer	☐	Object reference (TYPE REF TO)	CL_CHIP_PORT_EVENT_DATA		Port-Event mit Bezug auf ABAP-Daten	20081216

Method CAST_PORT_EVENT on class CL_CHIP_PORT_HELPER has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_CHIP_PORT_HELPER has no parameter.
Method CLASS_CONSTRUCTOR on class CL_CHIP_PORT_HELPER has no exception.

Method COPY_PORT_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ADDITIONAL_PORT_TAGGINGS	Call by reference	☑	Type reference (TYPE)	CHIP_TAGGING_INFOS		Tagging-Information zu einem Chip	20110302
2	Importing	NEW_PORT_NAME	Call by reference	☑	Type reference (TYPE)	STRING			20100715
3	Importing	PORT_DESCRIPTION	Call by reference	☐	Object reference (TYPE REF TO)	IF_CHIP_PORT_DESCRIPTION		CHIP Port Beschreibung	20100105
4	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_CHIP_PORT_DESCRIPTION		CHIP Port Beschreibung	20100105

Method COPY_PORT_DESCRIPTION on class CL_CHIP_PORT_HELPER has no exception.

Method CREATE_PARAMETER_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PARAMETER_DESCRIPTION	Value transfer	☐	Object reference (TYPE REF TO)	CL_CHIP_PARAMETER_DESCRIPTION		CHIP Parameter Beschreibung	20081104
2	Importing	PARAMETER_META_DATA	Call by reference	☐	Type reference (TYPE)	PARAMETER_DESCRIPTION			20081104

Method CREATE_PARAMETER_DESCRIPTION on class CL_CHIP_PORT_HELPER has no exception.

Method CREATE_PORT_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DESCRIPTION	Value transfer	☑	Type reference (TYPE)	STRING		Beschreibung	20081103
2	Importing	DISPLAY_NAME	Value transfer	☑	Type reference (TYPE)	STRING		Name für die Anzeige	20081103
3	Importing	IS_ARRAY	Call by reference	☐	Type reference (TYPE)	WDY_BOOLEAN	ABAP_FALSE	Tabellenartig?	20081103
4	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name des Ports	20081103
5	Importing	PARAMETERS	Call by reference	☐	Type reference (TYPE)	PARAMETER_DESCRIPTIONS		Beschreibung der Parameter	20081103
6	Returning	PORT_DESCRIPTION	Value transfer	☐	Object reference (TYPE REF TO)	IF_CHIP_PORT_DESCRIPTION		CHIP Port Beschreibung	20081103
7	Importing	TAGGING	Call by reference	☑	Type reference (TYPE)	CHIP_TAGGING_INFOS		Tagging-Information zu einem Chip-Port	20090928
8	Importing	TYPENAME	Value transfer	☐	Type reference (TYPE)	ABAP_ABSTYPENAME		Name eines Typs, der alle Parameter enthält	20081107

Method CREATE_PORT_DESCRIPTION on class CL_CHIP_PORT_HELPER has no exception.

Method CREATE_PORT_DESCRIPTION_INT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DESCRIPTION	Value transfer	☑	Type reference (TYPE)	STRING		Beschreibung	20081110
2	Importing	DISPLAY_NAME	Value transfer	☑	Type reference (TYPE)	STRING		Name für die Anzeige	20081110
3	Importing	IS_ARRAY	Call by reference	☐	Type reference (TYPE)	WDY_BOOLEAN	ABAP_FALSE	Tabellenartig?	20081110
4	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING		Name des Ports	20081110
5	Importing	PARAMETERS	Call by reference	☐	Type reference (TYPE)	PARAMETER_DESCRIPTIONS		Beschreibung der Parameter	20081110
6	Returning	PORT_DESCRIPTION	Value transfer	☐	Object reference (TYPE REF TO)	IF_CHIP_PORT_DESCRIPTION		CHIP Port Beschreibung	20081110
7	Importing	STRUCT_DESCR	Call by reference	☑	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Run Time Type Services	20081223
8	Importing	TAGGING	Call by reference	☑	Type reference (TYPE)	CHIP_TAGGING_INFOS		Tagging-Information zu einem Chip-Port	20090928
9	Importing	TYPENAME	Value transfer	☑	Type reference (TYPE)	ABAP_ABSTYPENAME		Name eines Typs, der alle Parameter enthält	20081110
10	Importing	USE_PARNAME_AS_FIELDNAME	Call by reference	☐	Type reference (TYPE)	WDY_BOOLEAN	ABAP_FALSE	können Parameternamen als Feldnamen verwendet werden	20081110

Method CREATE_PORT_DESCRIPTION_INT on class CL_CHIP_PORT_HELPER has no exception.

Method CREATE_PORT_DESCR_FROM_DDIC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PORT_DESCRIPTION	Value transfer	☐	Object reference (TYPE REF TO)	IF_CHIP_PORT_DESCRIPTION		CHIP Port Beschreibung	20081104
2	Importing	PORT_DESCR_DDIC	Call by reference	☐	Type reference (TYPE)	CHIP_PORT_BY_DDIC		Beschreibung eines Ports über eine DDIC-Struktur	20081104

#	Exception	Resumable	Description	Created on
1	CX_CHIP_CATALOG	☐	Fehlerklasse für CHIP Katalog	20081203

Method CREATE_PORT_DESCR_FROM_RTTI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	PORT_DESCRIPTION	Value transfer	☐	Object reference (TYPE REF TO)	IF_CHIP_PORT_DESCRIPTION		CHIP Port Beschreibung	20081223
2	Importing	PORT_DESCR_RTTI	Call by reference	☐	Type reference (TYPE)	CHIP_PORT_BY_RTTI		Beschreibung eines Ports über eine DDIC-Struktur	20081223

#	Exception	Resumable	Description	Created on
1	CX_CHIP_CATALOG	☐	Fehlerklasse für CHIP Katalog	20081223

Method CREATE_PORT_EVENT_FROM_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DATA	Call by reference	☐	Type reference (TYPE)	DATA			20081216
2	Importing	PORT	Call by reference	☐	Object reference (TYPE REF TO)	IF_CHIP_PORT_DESCRIPTION		CHIP Port Beschreibung	20081216
3	Returning	PORT_EVENT	Value transfer	☐	Object reference (TYPE REF TO)	IF_CHIP_PORT_EVENT		CHIP Port Event	20081216

Method CREATE_PORT_EVENT_FROM_DATA on class CL_CHIP_PORT_HELPER has no exception.

Method GET_DATA_FROM_PORT_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	DATA_CHANGE	Call by reference	☑	Type reference (TYPE)	DATA		Daten werden in diese Struktur übertragen	20081216
2	Exporting	DATA_EXPORT	Value transfer	☐	Type reference (TYPE)	STANDARD TABLE		Daten im Port-spezifischen Format	20081216
3	Importing	PORT_DESCRIPTION	Call by reference	☐	Object reference (TYPE REF TO)	IF_CHIP_PORT_DESCRIPTION		Beschreibung des Ports	20081216
4	Importing	PORT_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_CHIP_PORT_EVENT		Port Event	20081216

Method GET_DATA_FROM_PORT_EVENT on class CL_CHIP_PORT_HELPER has no exception.

Method GET_PARAMETERS_FROM_RTTI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	PARAMETERS	Call by reference	☐	Type reference (TYPE)	PARAMETER_DESCRIPTIONS			20081223
2	Importing	PARAMETERS_ADD_INFO	Call by reference	☐	Type reference (TYPE)	CHIP_PARAMS_ADD_INFO		Beschreibung eines Ports über eine DDIC-Struktur	20081223
3	Importing	STRUCT_DESCR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR		Run Time Type Services	20081223

#	Exception	Resumable	Description	Created on
1	CX_CHIP_CATALOG	☐	Fehlerklasse für CHIP Katalog	20081223

Method GET_PORTS_WITH_PARAMETERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PORT_INFOS	Call by reference	☐	Type reference (TYPE)	CHIP_PORT_INFO_TAB		Abbildung Name zu Definition eines Ports	20101110
2	Returning	PORT_INFOS_WITH_PARAMETERS	Value transfer	☐	Type reference (TYPE)	CHIP_PORT_INFO_TAB		Abbildung Name zu Definition eines Ports	20101110

Method GET_PORTS_WITH_PARAMETERS on class CL_CHIP_PORT_HELPER has no exception.

Method GET_PORT_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHIP_INSTANCE_ID	Call by reference	☐	Type reference (TYPE)	STRING		Instanz ID des CHIP	20081121
2	Importing	IS_OUTPORT	Call by reference	☐	Type reference (TYPE)	WDY_BOOLEAN		handelt es sich um Outport (oder Inport)	20081121
3	Importing	PORT	Call by reference	☐	Type reference (TYPE)	STRING		Name des Ports	20081121
4	Returning	PORT_DESCRIPTION	Value transfer	☐	Object reference (TYPE REF TO)	IF_CHIP_PORT_DESCRIPTION		Beschreibung des spezifizierten Ports (falls existent)	20081121

Method GET_PORT_DESCRIPTION on class CL_CHIP_PORT_HELPER has no exception.

Method GET_PORT_DESCRIPTION_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ONLY_SIGNATURE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100723
2	Importing	PORT_DESCRIPTION	Call by reference	☐	Object reference (TYPE REF TO)	IF_CHIP_PORT_DESCRIPTION		CHIP Port Beschreibung	20100528
3	Returning	PORT_DESCRIPTION_VERSION	Value transfer	☐	Type reference (TYPE)	STRING			20100528
4	Importing	PORT_TYPE	Call by reference	☐	Type reference (TYPE)	CHIP_PORT_TYPE		PageBuilder: Typ eines CHIP-Ports	20100702

Method GET_PORT_DESCRIPTION_VERSION on class CL_CHIP_PORT_HELPER has no exception.

Method GET_PORT_DESCRIPTION_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ONLY_SIGNATURE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100723
2	Importing	ONLY_TECHNICAL_NAMES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100528
3	Importing	PORT_DESCRIPTION	Call by reference	☐	Object reference (TYPE REF TO)	IF_CHIP_PORT_DESCRIPTION		CHIP Port Beschreibung	20100528
4	Returning	PORT_DESCRIPTION_XML	Value transfer	☐	Type reference (TYPE)	XSTRING			20100528
5	Importing	PORT_TYPE	Call by reference	☐	Type reference (TYPE)	CHIP_PORT_TYPE		PageBuilder: Typ eines CHIP-Ports	20100702
6	Importing	PRETTY_PRINT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20100528

Method GET_PORT_DESCRIPTION_XML on class CL_CHIP_PORT_HELPER has no exception.

Method GET_PORT_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	PORT_DESCRIPTION	Call by reference	☐	Object reference (TYPE REF TO)	IF_CHIP_PORT_DESCRIPTION		CHIP Port Beschreibung	20101125
2	Returning	RELATIVE_TYPE	Value transfer	☐	Type reference (TYPE)	STRING			20101125

Method GET_PORT_TYPE on class CL_CHIP_PORT_HELPER has no exception.

Method IS_VALID_PORT_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHIP_INSTANCE	Call by reference	☐	Object reference (TYPE REF TO)	IF_CHIP_INSTANCE		CHIP Instanz	20110810
2	Returning	IS_VALID_PORT_EVENT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20110810
3	Importing	PORT_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_CHIP_PORT_EVENT		CHIP Port Event	20110810
4	Importing	PORT_TYPE	Call by reference	☐	Type reference (TYPE)	CHIP_PORT_TYPE		PageBuilder: Typ eines CHIP-Ports	20110810

Method IS_VALID_PORT_EVENT on class CL_CHIP_PORT_HELPER has no exception.

Method PORT_HAS_PARAMETERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	HAS_PARAMETERS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20101110
2	Importing	PORT_DESCRIPTION	Call by reference	☐	Object reference (TYPE REF TO)	IF_CHIP_PORT_DESCRIPTION		CHIP Port Beschreibung	20101110

Method PORT_HAS_PARAMETERS on class CL_CHIP_PORT_HELPER has no exception.

History

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