IF_WD_RR_CMP_USAGE_GROUP 

Das Interface IF_WD_RR_CMP_USAGE_GROUP gehört zur API des Web-Dynpro-Runtime-Repositories.

Das Interface IF_WD_RR_CMP_USAGE_GROUP ermöglicht den Zugriff auf die Metadaten einer Component-Usage-Group. Mit einer Component-Usage-Group kann eine beliebige Anzahl von Component-Usages dynamisch erzeugt und verwaltet werden, die auf den gleichen Component-Typ bzw. Component-Interface-Typ zeigen. Zu beachten ist, dass dieses Interface lediglich die Metadaten einer Component-Usage-Group beschreibt. Zur Steuerung des Laufzeitverhaltens einer Component-Usage-Group steht das Interface IF_WD_COMPONENT_USAGE_GROUP zur Verfügung. Damit können z.B. Component-Usages zur Component-Usage-Group hinzugefügt bzw. aus ihr entfernt werden. Das Erzeugen einer Component-Usage-Group ist nur zur Laufzeit mit Hilfe der Methode IF_WD_COMPONENT~CREATE_CMP_USAGE_GROUP möglich.

Verwendung

Der Zugriff auf das Interface IF_WD_RR_CMP_USAGE_GROUP erfolgt z.B. innerhalb einer Methode des Component-Controllers einer Web-Dynpro-Component wie folgt:

data: l_component_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> ).

Methoden

Methode IF_WD_RR_CMP_USAGE_GROUP=>GET_COMPONENT_USAGE

Diese Methode gibt das in der Component-Usage-Group enthaltene Beschreibungsobjekt der Component-Usage des Namens NAME zurück.

Ergebnis

Name	Beschreibung
RESULT( ref to IF_WD_RR_COMPONENT_USAGE)	Component-Usage

Ausnahmen

Es wird die Ausnahme CX_WDR_RR_EXCEPTION ausgelöst, wenn

...

       1.      keine Component-Usage des Namens NAME existiert.

       2.      die Component-Usage des Namens NAME nicht in der Component-Usage-Group enthalten ist.

Methode IF_WD_RR_CMP_USAGE_GROUP=>GET_COMPONENT_USAGES

Diese Methode gibt die Beschreibungsobjekte der Component-Usages zurück, die in der Component-Usage-Group enthalten sind.

Ergebnis

Name	Beschreibung
RESULT (Typ WDRR_CMP_USAGE_OBJECTS)	Tabelle der Component-Usages, die in der Gruppe enthalten sind

 

Methode IF_WD_RR_CMP_USAGE_GROUP=>GET_NAME

Diese Methode gibt den Namen der Component-Usage-Group zurück.

Ergebnis

Name	Beschreibung
RESULT(Typ STRING)	Name der Component-Usage-Group