IF_WD_RR_COMPONENT_USAGE 

Interface IF_WD_RR_COMPONENT_USAGE belongs to the API for the Web Dynpro Runtime Repository.

Interface IF_WD_RR_COMPONENT_USAGE allows access to the metadata for a Web Dynpro component usage.

Use

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

data: l_component_api        type ref to if_wd_component, l_component_info       type ref to if_wd_rr_component. l_component_usage_info type ref to if_wd_rr_component_usage.   l_component_api        = wd_this->wd_get_api( ). l_component_info       = l_component_api->get_component_info( ). l_component_usage_info = l_component_info->get_component_usage(          component_usage_name = <name of the component usage> ).

Methods

GET_LIFECYCLE_CONTROL

This method can be used to query whether the component that this component usage relates to should be created automatically when its interface controller is accessed, or whether it should be created manually (by calling method IF_WD_COMPONENT_USAGE~CREATE_COMPONENT).

Result

Name	Description
RESULT (Type STRING)	Specifies whether an instance of the component that this component usage points to should be created when its interface controller is accessed.

Possible values are:

●      IF_WD_RR_COMPONENT_USAGE=>CREATE_MANUAL:

The used component must be created by calling IF_WD_COMPONENT_USAGE~CREATE_COMPONENT before its interface controller can be accessed (standard behavior).

●      IF_WD_RR_COMPONENT_USAGE=>CREATE_ON_DEMAND:

The used component is created by the Web Dynpro runtime as soon as its interface controller is accessed.

GET_NAME

This method returns the name of the component usage.

Result

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

 

SET_LIFECYCLE_CONTROL

This method specifies whether an instance of the component to which this component usage points is to be created by the Web Dynpro runtime when its interface controller is accessed.

Independent of this a component is then created by the Web Dynpro runtime if the interface view of this component is to be displayed.

Parameter

Name	Description
LIFECYCLE_CONTROL (type STRING)	Specifies whether an instance of the component that this component usage points to should be created when its interface controller is accessed.

Possible values are:

●      IF_WD_RR_COMPONENT_USAGE=>CREATE_MANUAL:

The used component must be created by calling IF_WD_COMPONENT_USAGE~CREATE_COMPONENT before its interface controller can be accessed (standard behavior).

●      IF_WD_RR_COMPONENT_USAGE=>CREATE_ON_DEMAND:

The used component is created by the Web Dynpro runtime as soon as its interface controller is accessed.