IF_WD_RR_COMPONENT 

Das Interface IF_WD_RR_COMPONENT gehört zur API des Web-Dynpro-Runtime-Repositories. Das Interface IF_WD_RR_COMPONENT ermöglicht den Zugriff auf die Metadaten einer Web-Dynpro-Component.

Verwendung

Der Zugriff auf dieses Interface 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_component_api  = wd_this->wd_get_api( ). l_component_info = l_component_api->get_component_info( ).

Methoden

CREATE_CMP_USAGE_GROUP

Diese Methode erzeugt das Beschreibungsobjekt 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.

Beachten Sie, dass diese Methode das Beschreibungsobjekt einer Component-Usage-Group erzeugt und nicht deren Laufzeitobjekt. Die Erzeugung des Laufzeitobjektes einer Component-Usage-Group erfolgt mit der Methode IF_WD_COMPONENT~CREATE_CMP_USAGE_GROUP. Dabei wird das Beschreibungsobjekt der Component-Usage-Group implizit erzeugt, so dass ein separater Aufruf der Methode CREATE_CMP_USAGE_GROUP nicht notwendig ist.

Ergebnis

Name	Beschreibung
RESULT (ref to IF_WD_RR_CMP_USAGE_GROUP)	Beschreibungsobjekt der Component-Usage-Group

 

Parameter

Name	Beschreibung
NAME (Typ STRING)	Name der Component-Usage-Group
USED_COMPONENT (Typ STRING)	Name der verwendeten Component

 

GET_CMP_USAGES_FOR_CMP

Diese Methode gibt die Namen der Component-Verwendungen der in COMPONENT_NAME angegebenen Component zurück. Zusätzlich kann die Liste der Component-Interfaces angefordert werden, die von der verwendeten Component implementiert werden.

Ergebnis

Name	Beschreibung
RESULT (Typ IF_WD_RR_COMPONENT~TY_T_COMPONENT_USAGES)	Liste aller Component-Verwendungen der angegebenen Component

 

Parameter

Name	Beschreibung
COMPONENT_NAME (Typ STRING)	Name der Component
WITH_IMPLEMENTED_INTERFACES (Typ ABAP_BOOL)	Hat dieser Parameter den Wert ABAP_TRUE, dann wird zusätzlich die Liste aller Component-Interfaces zurückgegeben, die von der verwendeten Component implementiert werden. Dieser Parameter ist optional und hat den Standardwert ABAP_FALSE

 

GET_CMP_USAGE_GROUP

Diese Methode gibt das Beschreibungsobjekt einer Component-Usage-Group zurück. 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 diese Methode das Beschreibungsobjekt einer Component-Usage-Group zurückliefert und nicht deren Laufzeitobjekt. 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.

Ergebnis

Name	Beschreibung
RESULT (ref to IF_WD_RR_CMP_USAGE_GROUP)	Beschreibungsobjekt der Component-Usage-Group

 

Parameter

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

 

Ausnahmen

Existiert innerhalb der Web-Dynpro-Component keine Component-Usage-Group des Namens NAME, dann wird die Ausnahme CX_WDR_RR_EXCEPTION ausgelöst

 

GET_COMPONENT_USAGE

Diese Methode gibt das Beschreibungsobjekt einer Component-Usage zurück.

Ergebnis

Name	Beschreibung
RESULT (ref to IF_WD_RR_COMPONENT)	Beschreibungsobjekt der Component-Usage

 

Parameter

Name	Beschreibung
COMPONENT_USAGE_NAME (Typ STRING)	Name der Component-Usage

 

Ausnahmen

Existiert innerhalb der Web-Dynpro-Component keine Component-Usage des Namens COMPONENT_USAGE_NAME, dann wird die Ausnahme CX_WDR_RR_EXCEPTION ausgelöst

 

GET_COMPONENT_USAGES

Diese Methode liefert eine Liste aller Component-Verwendungen dieser Component zurück.

Ergebnis

Name	Beschreibung
RESULT (Typ WDRR_CMP_USAGE_OBJECTS)	Liste aller Component-Verwendungen

 

GET_CONFIG_PROPERTIES

Diese Methode gibt Konfigurationseigenschaften zurück.

Ergebnis

Name	Beschreibung
RESULT (Typ WDY_CONFIG_PROPS)	Konfigurationseigenschaften

 

GET_CONTROLLER

Diese Methode gibt das Beschreibungsobjekt eines Controllers zurück.

Ergebnis

Name	Beschreibung
RESULT (ref to IF_WD_RR_CONTROLLER)	Beschreibungsobjekt des Controllers

 

Parameter

Name	Beschreibung
CONTROLLER_NAME (Typ STRING)	Name des Controllers

 

Ausnahmen

Existiert innerhalb der Web-Dynpro-Component kein Controller des Namens CONTROLLER_NAME, dann wird die Ausnahme CX_WDR_RR_EXCEPTION ausgelöst

 

GET_IMPLEMENTED_INTERFACES

Diese Methode gibt die Namen aller Component-Interfaces zurück, die von dieser Component implementiert werden.

Ergebnis

Name	Beschreibung
RESULT (Typ STRING_TABLE)	Namen aller Component-Interfaces, die von dieser Component implementiert werden

 

GET_IMPL_COMPONENTS

Diese statische Methode gibt eine Tabelle der Namen aller Components zurück, die das angegebene Component-Interface implementieren.

Ergebnis

Name	Beschreibung
RESULT (Typ STRING_TABLE)	Namen aller Components, die das angegebende Component-Interface implementieren

 

Parameter

Name	Beschreibung
COMPONENT_INTF_NAME (Typ STRING)	Name des Component-Interfaces

 

GET_IMPL_INTERFACES_FOR_CMP

Diese statische Methode gibt die Namen aller Component-Interfaces zurück, die von der Component des in COMPONENT_NAME angegebenen Namens implementiert werden.

Ergebnis

Name	Beschreibung
RESULT (Typ STRING_TABLE)	Namen aller Component-Interfaces, die von der angegebenen Component implementiert werden

 

Parameter

Name	Beschreibung
NAME (Typ STRING)	Name der Component

 

GET_NAME

Diese Methode gibt den Namen der Web-Dynpro-Component zurück.

Ergebnis

Name	Beschreibung
NAME (Typ STRING)	Name der Component

 

GET_VIEW

Diese Methode gibt das Beschreibungsobjekt einer View zurück.

Ergebnis

Name	Beschreibung
RESULT (ref to IF_WD_RR_VIEW)	Beschreibungsobjekt der View

 

Parameter

Name	Beschreibung
VIEW_NAME (Typ STRING)	Name der View

 

Ausnahmen

Existiert innerhalb der Web Dynpro-Component keine View des Namens VIEW_NAME, dann wird die Ausnahme CX_WDR_RR_EXCEPTION ausgelöst

 

GET_WINDOW

Diese Methode gibt das Beschreibungsobjekt eines Windows zurück.

Ergebnis

Name	Beschreibung
RESULT (ref to IF_WD_RR_WINDOW)	Beschreibungsobjekt des Windows

 

Parameter

Name	Beschreibung
WINDOW_NAME (Typ STRING)	Name des Windows

 

Ausnahmen

Existiert innerhalb der Web Dynpro-Component kein Window des Namens WINDOW_NAME, dann wird die Ausnahme CX_WDR_RR_EXCEPTION ausgelöst