IF_WD_RR_COMPONENT 

Interface IF_WD_RR_COMPONENT belongs to the API for the Web Dynpro Runtime Repository. Interface IF_WD_RR_COMPONENT allows access to the metadata for a Web Dynpro component.

Use

This interface is accessed, for example, in a component controller method in a Web Dynpro component as follows:

data: data: l_cmp_api           type ref to if_wd_component,       l_component_info type ref to if_wd_rr_component,   l_component_api  = wd_this->wd_get_api( ). l_component_info = l_component_api->get_component_info( ).

Methods

CREATE_CMP_USAGE_GROUP

This method creates the description object for a component usage group. A component usage group can be used to dynamically create and administrate any number of component usages that point to the same component type or component interface type.

This method creates the description object for a component usage group, and not its runtime object. The runtime object for a component usage group is created using method IF_WD_COMPONENT~CREATE_CMP_USAGE_GROUP. The description object for the component usage group is then created implicitly, thus making it unnecessary to call method CREATE_CMP_USAGE_GROUP separately.

Result

Name	Description
RESULT( reference to IF_WD_RR_CMP_USAGE_GROUP)	Description object of the component usage group

 

Parameter

Name	Description
NAME (Type STRING)	The name of the component usage group
USED_COMPONENT (type STRING):	Name of the component used

 

GET_CMP_USAGES_FOR_CMP

This method returns the name of the component usages of the component returned in COMPONENT_NAME. The list of component interfaces implemented by the used component can also be requested.

Result

Name	Description
RESULT (type IF_WD_RR_COMPONENT~TY_T_COMPONENT_USAGES)	List of all component usages of the specified component

 

Parameter

Name	Description
COMPONENT_NAME (type STRING):	Name of the component
WITH_IMPLEMENTED_INTERFACES (type ABAP_BOOL):	If this parameter has the value ABAP_TRUE, the list of component interfaces implemented by the used component will also be displayed. This parameter is optional and its default value is ABAP_FALSE.

 

GET_CMP_USAGE_GROUP

This method returns the description object for a component usage group. A component usage group can be used to dynamically create and administrate any number of component usages that are displayed on the same component type or component interface type.

Note that this method returns the description object for a component usage group and not its runtime object. To control the runtime behavior of a component usage group, interface IF_WD_COMPONENT_USAGE_GROUP is provided. This can be used, for example, to add component usages to the component usage group or to remove them. A component usage group can only be created at runtime using method IF_WD_COMPONENT~CREATE_CMP_USAGE_GROUP.

Result

Name	Description
RESULT( reference to IF_WD_RR_CMP_USAGE_GROUP)	Description object of the component usage group

 

Parameter

Name	Description
NAME (Type STRING)	The name of the component usage group

 

Exceptions

If the Web Dynpro component does not contain a component usage group with the name NAME, the system triggers exception CX_WDR_RR_EXCEPTION.

 

GET_COMPONENT_USAGE

This method returns the description object for a component usage.

Result

Name	Description
RESULT( reference to IF_WD_RR_COMPONENT_USAGE_USAGE)	Description object of the component usage

 

Parameter

Name	Description
COMPONENT_USAGE_NAME (type STRING)	The name of the component usage

 

Exceptions

If there is no component usage with the name COMPONENT_USAGE_NAME within the Web Dynpro component, the system triggers exception CX_WDR_RR_EXCEPTION.

 

GET_COMPONENT_USAGES

This method returns a list of all component usage for this component.

Result

Name	Description
RESULT (type WDRR_CMP_USAGE_OBJECTS)	List of all component usages

 

GET_CONFIG_PROPERTIES

This method returns the configuration properties.

Result

Name	Description
RESULT (type WDY_CONFIG_PROPS)	Configuration properties

 

GET_CONTROLLER

This method returns the description object for a controller.

Result

Name	Description
RESULT( reference to IF_WD_RR_CONTROLLER)	Description object of the controller

 

Parameter

Name	Description
CONTROLLER_NAME (Type STRING)	Name of the controller

 

Exceptions

If the Web Dynpro component does not contain a controller with the name CONTROLLER_NAME, the system triggers exception CX_WDR_RR_EXCEPTION.

 

GET_IMPLEMENTED_INTERFACES

This method returns the names of all component interfaces that are implemented by this component.

Result

Name	Description
RESULT (type STRING_TABLE)	Names of all the component interfaces implemented by this component

 

GET_IMPL_COMPONENTS

This statistical method returns a table containing the names of all components that implement the specified component interface.

Result

Name	Description
RESULT (type STRING_TABLE)	Names of all components that implement the specified component interface.

 

Parameter

Name	Description
COMPONENT_INTF_NAME (type STRING)	Name of the component interface

 

GET_IMPL_INTERFACES_FOR_CMP

This static method returns the names of all component interfaces that are implemented by the component with the name specified in COMPONENT_NAME.

Result

Name	Description
RESULT (type STRING_TABLE)	Names of all the component interfaces implemented by the specified component

 

Parameter

Name	Description
NAME (Type STRING)	Name of the component

 

GET_NAME

This method returns the name of the Web Dynpro component.

Result

Name	Description
NAME (Type STRING)	Name of the component

 

GET_VIEW

This method returns the description object for a view.

Result

Name	Description
RESULT (reference to IF_WD_RR_VIEW)	Description object of the view

 

Parameter

Name	Description
VIEW_NAME (type STRING)	Name of the view

 

Exceptions

If the Web Dynpro component does not contain a view with the name VIEW_NAME, the system triggers exception CX_WDR_RR_EXCEPTION.

 

GET_WINDOW

This method returns the description object for a window.

Result

Name	Description
RESULT (reference to IF_WD_RR_WINDOW)	Description object of the window

 

Parameter

Name	Description
WINDOW_NAME (type STRING)	Name of the window

 

Exceptions

If the Web Dynpro component does not contain a window with the name WINDOW_NAME, the system triggers exception CX_WDR_RR_EXCEPTION.