IF_WD_RR_CMP_USAGE_GROUP 

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

Interface IF_WD_RR_CMP_USAGE_GROUP allows access to the metadata 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 interface only describes the metadata for a component usage group. 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.

Use

Access to interface IF_WD_RR_CMP_USAGE_GROUP, for example in a component controller method, is made as follows:

data: data: l_cmp_api           type ref to if_wd_component,     l_component_info          type ref to if_wd_rr_component,     l_cmp_usage_group_info    type ref to if_wd_rr_cmp_usage_group.   l_component_api        = wd_this->wd_get_api( ). l_component_info       = l_component_api->get_component_info( ). l_cmp_usage_group_info = l_component_info->get_cmp_usage_group( name =  <Name der Component-usage-Group> ).

Methods

Method IF_WD_RR_CMP_USAGE_GROUP=>GET_COMPONENT_USAGE

This method returns the description object from the component usage group for component usage.

Result

Name	Description
RESULT( reference to IF_WD_RR_COMPONENT_USAGE)	Component Usage

Exceptions

Exception CX_WDR_RR_EXCEPTION is triggered if:

...

       1.      No component usage with the name NAME exists.

       2.      The component usage with the name NAME is not contained in the component usage group.

Method IF_WD_RR_CMP_USAGE_GROUP=>GET_COMPONENT_USAGES

This method returns the description objects for the component usages contained in the component usage group.

Result

Name	Description
RESULT (type WDRR_CMP_USAGE_OBJECTS)	Table of component usages contained in the group.

 

Method IF_WD_RR_CMP_USAGE_GROUP=>GET_NAME

This method returns the name of the component usage group.

Result

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