SAP ABAP Class /UI2/CL_CHIP_PORT_HELPER (Help Classes for Creating Ports)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ CA-UI2-INT-BE (Application Component) Backend Enablement
     ⤷ /UI2/ABAP_PAGE_BUILDER (Package) UI2: ABAP Pagebuilder

Properties

Class	/UI2/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	/UI2/ABAP_PAGE_BUILDER	UI2: ABAP Pagebuilder
Created	20130313	SAP
Last change	20131127	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 /UI2/CL_CHIP_PORT_HELPER has no interface implemented.

Friends

Class /UI2/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			20130313
2	CLASS_OF_PORT_DESCRIPTION	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_ABAP_OBJECTDESCR			20130313
3	PARAMETER_USAGE_NOT	Constant	Public	☐	Type reference (TYPE)	/UI2/CHIP_PARAMETER_USAGE_INFO	'-'		20130313
4	PARAMETER_USAGE_OPTIONAL	Constant	Public	☐	Type reference (TYPE)	/UI2/CHIP_PARAMETER_USAGE_INFO	' '		20130313
5	PARAMETER_USAGE_REQUIRED	Constant	Public	☐	Type reference (TYPE)	/UI2/CHIP_PARAMETER_USAGE_INFO	'X'		20130313

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CAST_PORT_EVENT	Static method	Public	Method		20130313
2	CLASS_CONSTRUCTOR	Static method	Public	Constructor		20130313
3	COPY_PORT_DESCRIPTION	Static method	Public	Method		20130313
4	CREATE_PARAMETER_DESCRIPTION	Static method	Public	Method		20130313
5	CREATE_PORT_DESCRIPTION	Static method	Public	Method		20130313
6	CREATE_PORT_DESCRIPTION_INT	Static method	Private	Method		20130313
7	CREATE_PORT_DESCR_FROM_DDIC	Static method	Public	Method		20130313
8	CREATE_PORT_DESCR_FROM_RTTI	Static method	Public	Method		20130313
9	CREATE_PORT_EVENT_FROM_DATA	Static method	Public	Method		20130313
10	GET_DATA_FROM_PORT_EVENT	Static method	Public	Method		20130313
11	GET_PARAMETERS_FROM_RTTI	Static method	Private	Method		20130313
12	GET_PORTS_WITH_PARAMETERS	Static method	Public	Method		20130313
13	GET_PORT_DESCRIPTION	Static method	Public	Method		20130313
14	GET_PORT_DESCRIPTION_VERSION	Static method	Public	Method		20130313
15	GET_PORT_DESCRIPTION_XML	Static method	Public	Method		20130313
16	GET_PORT_TYPE	Static method	Public	Method		20130313
17	IS_VALID_PORT_EVENT	Static method	Public	Method		20130313
18	PORT_HAS_PARAMETERS	Static method	Public	Method		20130313

Events

Class /UI2/CL_CHIP_PORT_HELPER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	PARAMETER_DESCRIPTION	Public	See coding			20130313	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 /ui2/chip_tagging_infos, END OF parameter_description
2	PARAMETER_DESCRIPTIONS	Public	See coding			20130313	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)	/UI2/IF_CHIP_PORT_EVENT			20130313
2	Returning	PORT_EVENT_DATA	Value transfer	☐	Object reference (TYPE REF TO)	/UI2/CL_CHIP_PORT_EVENT_DATA			20130313

Method CAST_PORT_EVENT on class /UI2/CL_CHIP_PORT_HELPER has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class /UI2/CL_CHIP_PORT_HELPER has no parameter.
Method CLASS_CONSTRUCTOR on class /UI2/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)	/UI2/CHIP_TAGGING_INFOS			20130313
2	Importing	NEW_PORT_NAME	Call by reference	☑	Type reference (TYPE)	STRING			20130313
3	Importing	PORT_DESCRIPTION	Call by reference	☐	Object reference (TYPE REF TO)	/UI2/IF_CHIP_PORT_DESCRIPTION			20130313
4	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	/UI2/CL_CHIP_PORT_DESCRIPTION		CHIP Port Description Implementation	20130313

Method COPY_PORT_DESCRIPTION on class /UI2/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)	/UI2/CL_CHIP_PAR_DESCRIPTION			20130313
2	Importing	PARAMETER_META_DATA	Call by reference	☐	Type reference (TYPE)	PARAMETER_DESCRIPTION			20130313

Method CREATE_PARAMETER_DESCRIPTION on class /UI2/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	Call by reference	☑	Type reference (TYPE)	STRING			20130313
2	Importing	DISPLAY_NAME	Call by reference	☑	Type reference (TYPE)	STRING			20130313
3	Importing	IS_ARRAY	Call by reference	☐	Type reference (TYPE)	WDY_BOOLEAN	ABAP_FALSE		20130313
4	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING			20130313
5	Importing	PARAMETERS	Call by reference	☐	Type reference (TYPE)	PARAMETER_DESCRIPTIONS			20130313
6	Returning	PORT_DESCRIPTION	Value transfer	☐	Object reference (TYPE REF TO)	/UI2/IF_CHIP_PORT_DESCRIPTION			20130313
7	Importing	TAGGING	Call by reference	☑	Type reference (TYPE)	/UI2/CHIP_TAGGING_INFOS			20130313
8	Importing	TYPENAME	Call by reference	☐	Type reference (TYPE)	ABAP_ABSTYPENAME			20130313

Method CREATE_PORT_DESCRIPTION on class /UI2/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			20130313
2	Importing	DISPLAY_NAME	Value transfer	☑	Type reference (TYPE)	STRING			20130313
3	Importing	IS_ARRAY	Call by reference	☐	Type reference (TYPE)	WDY_BOOLEAN	ABAP_FALSE		20130313
4	Importing	NAME	Call by reference	☐	Type reference (TYPE)	STRING			20130313
5	Importing	PARAMETERS	Call by reference	☐	Type reference (TYPE)	PARAMETER_DESCRIPTIONS			20130313
6	Returning	PORT_DESCRIPTION	Value transfer	☐	Object reference (TYPE REF TO)	/UI2/IF_CHIP_PORT_DESCRIPTION			20130313
7	Importing	STRUCT_DESCR	Call by reference	☑	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR			20130313
8	Importing	TAGGING	Call by reference	☑	Type reference (TYPE)	/UI2/CHIP_TAGGING_INFOS			20130313
9	Importing	TYPENAME	Call by reference	☑	Type reference (TYPE)	ABAP_ABSTYPENAME			20130313
10	Importing	USE_PARNAME_AS_FIELDNAME	Call by reference	☐	Type reference (TYPE)	WDY_BOOLEAN	ABAP_FALSE		20130313

Method CREATE_PORT_DESCRIPTION_INT on class /UI2/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)	/UI2/IF_CHIP_PORT_DESCRIPTION			20130313
2	Importing	PORT_DESCR_DDIC	Call by reference	☐	Type reference (TYPE)	/UI2/CHIP_PORT_BY_DDIC			20130313

#	Exception	Resumable	Description	Created on
1	/UI2/CX_CHIP_CATALOG_CORE	☐		20130313

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)	/UI2/IF_CHIP_PORT_DESCRIPTION			20130313
2	Importing	PORT_DESCR_RTTI	Call by reference	☐	Type reference (TYPE)	/UI2/CHIP_PORT_BY_RTTI			20130313

#	Exception	Resumable	Description	Created on
1	/UI2/CX_CHIP_CATALOG_CORE	☐		20130313

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			20130313
2	Importing	PORT	Call by reference	☐	Object reference (TYPE REF TO)	/UI2/IF_CHIP_PORT_DESCRIPTION			20130313
3	Returning	PORT_EVENT	Value transfer	☐	Object reference (TYPE REF TO)	/UI2/IF_CHIP_PORT_EVENT			20130313

Method CREATE_PORT_EVENT_FROM_DATA on class /UI2/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			20130313
2	Exporting	DATA_EXPORT	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20130313
3	Importing	PORT_DESCRIPTION	Call by reference	☐	Object reference (TYPE REF TO)	/UI2/IF_CHIP_PORT_DESCRIPTION			20130313
4	Importing	PORT_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	/UI2/IF_CHIP_PORT_EVENT			20130313

Method GET_DATA_FROM_PORT_EVENT on class /UI2/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			20130313
2	Importing	PARAMETERS_ADD_INFO	Call by reference	☐	Type reference (TYPE)	/UI2/CHIP_PARAMS_ADD_INFO			20130313
3	Importing	STRUCT_DESCR	Call by reference	☐	Object reference (TYPE REF TO)	CL_ABAP_STRUCTDESCR			20130313

#	Exception	Resumable	Description	Created on
1	/UI2/CX_CHIP_CATALOG_CORE	☐		20130313

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)	/UI2/CHIP_PORT_INFO_TAB		Mapping of Name to Port Definition	20130313
2	Returning	PORT_INFOS_WITH_PARAMETERS	Value transfer	☐	Type reference (TYPE)	/UI2/CHIP_PORT_INFO_TAB		Mapping of Name to Port Definition	20130313

Method GET_PORTS_WITH_PARAMETERS on class /UI2/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			20130313
2	Importing	IS_OUTPORT	Call by reference	☐	Type reference (TYPE)	WDY_BOOLEAN			20130313
3	Importing	PORT	Call by reference	☐	Type reference (TYPE)	STRING			20130313
4	Returning	PORT_DESCRIPTION	Value transfer	☐	Object reference (TYPE REF TO)	/UI2/IF_CHIP_PORT_DESCRIPTION			20130313

Method GET_PORT_DESCRIPTION on class /UI2/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		20130313
2	Importing	PORT_DESCRIPTION	Call by reference	☐	Object reference (TYPE REF TO)	/UI2/IF_CHIP_PORT_DESCRIPTION			20130313
3	Returning	PORT_DESCRIPTION_VERSION	Value transfer	☐	Type reference (TYPE)	STRING			20130313
4	Importing	PORT_TYPE	Call by reference	☐	Type reference (TYPE)	/UI2/CHIP_PORT_TYPE			20130313

Method GET_PORT_DESCRIPTION_VERSION on class /UI2/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		20130313
2	Importing	ONLY_TECHNICAL_NAMES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20130313
3	Importing	PORT_DESCRIPTION	Call by reference	☐	Object reference (TYPE REF TO)	/UI2/IF_CHIP_PORT_DESCRIPTION			20130313
4	Returning	PORT_DESCRIPTION_XML	Value transfer	☐	Type reference (TYPE)	XSTRING			20130313
5	Importing	PORT_TYPE	Call by reference	☐	Type reference (TYPE)	/UI2/CHIP_PORT_TYPE			20130313
6	Importing	PRETTY_PRINT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20130313

Method GET_PORT_DESCRIPTION_XML on class /UI2/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)	/UI2/IF_CHIP_PORT_DESCRIPTION			20130313
2	Returning	RELATIVE_TYPE	Value transfer	☐	Type reference (TYPE)	STRING			20130313

Method GET_PORT_TYPE on class /UI2/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)	/UI2/IF_CHIP_INSTANCE			20130313
2	Returning	IS_VALID_PORT_EVENT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20130313
3	Importing	PORT_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	/UI2/IF_CHIP_PORT_EVENT			20130313
4	Importing	PORT_TYPE	Call by reference	☐	Type reference (TYPE)	/UI2/CHIP_PORT_TYPE			20130313

Method IS_VALID_PORT_EVENT on class /UI2/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			20130313
2	Importing	PORT_DESCRIPTION	Call by reference	☐	Object reference (TYPE REF TO)	/UI2/IF_CHIP_PORT_DESCRIPTION			20130313

Method PORT_HAS_PARAMETERS on class /UI2/CL_CHIP_PORT_HELPER has no exception.

History

Last changed by/on	SAP	20131127
SAP Release Created in	100