Ansicht
Dokumentation

CL_ISHMED_WIZARD - i.s.h.med: Basisklasse für einen beliebigen Wizard

CL_ISHMED_WIZARD - i.s.h.med: Basisklasse für einen beliebigen Wizard

RFUMSV00 - Advance Return for Tax on Sales/Purchases   General Data in Customer Master  
Diese Dokumentation steht unter dem Copyright der SAP AG.
SAP E-Book

Funktionalität

Die Klasse CL_ISHMED_WIZARD stellt die abstrakte Basisklasse zur Realisierung eines beliebigen Wizards (Assistenten) zur Verfügung. Sie implementiert das Interface IF_ISHMED_WIZARD, welches die Schnittstelle eines solchen Assistenten nach außen bildet.

Die Basisklasse verwaltet insgesamt vier Bereiche:

  • Arbeitsbereich
Die Basisklasse verwaltet eine beliebige Anzahl von Arbeitskapiteln, welche in einer vom Benutzer gewünschten Reihenfolge abgearbeitet werden können. Technisch gesehen müssen die einzelnen Arbeitskapitel der Schnittstelle IF_ISHMED_WIZARD_STEP genügen, da der Wizard mit Referenzen eben dieses Interfaces arbeitet. Unter Arbeitskapitel ist ein Dynpro mit einer damit entsprechend verbundenen Business-Logik zu verstehen.
Im Arbeitsbereich wird immer ein Arbeitskapitel angezeigt, dass aktuell auch bearbeitet werden kann.
  • Navigationsbereich
Der Navigationsbereich ermöglicht es, die eingebundenen Arbeitskapitel in der Reihenfolge ihrer Abarbeitung zu sehen. Der Navigationsbereich ist über die Schnittstelle IF_ISHMED_WIZARD_ROADMAP ansprechbar. Eine entsprechende Implementierung stellt die Klasse CL_ISHMED_WIZARD_ROADMAP_TREE dar.
  • Informationsbereich
Zuätzlich bietet die Basisklasse einen Informationsbereich an, in dem aktuelle Informationen zum aktuell angezeigten Arbeitskapitel angezeigt werden. Bei den Informationen, die angezeigt werden können, handelt es sich um Dokumentationsobjekte, die in der Transaktion SE61 gepflegt werden können. Über die Schnittstelle IF_ISHMED_WIZARD_INFO ist der Bereich ansprechbar. Eine entsprechende Implementierung stellt die Klasse CL_ISHMED_WIZARD_INFO dar.
  • Protokollbereich
Der Protokollbereich ermöglicht es, dass zusätzliche Informationen, die z.B. während des Prüfens des Wizards in einer Protokolltabelle befüllt werden, angezeigt werden. Der Protokollbereich wird über die Schnittstelle IF_ISHMED_WIZARD_PROTOCOL angesprochen. Eine entsprechende Implementierung stellt die Klasse CL_ISHMED_WIZARD_PROTOCOL dar.

Wie bereits erwähnt stellt das Interface IF_ISHMED_WIZARD die Schnittstelle nach außen dar und bietet über dessen Methoden Zugriff auf das Wizardobjekt.

Die Methode CREATE des Interfaces ermöglicht die Instanzierung des gewünschten Wizards alleine durch den Namen der Klasse.

Über die Methode RUN kann der Wizard schließlich gestartet werden.

Über diverse GET-Methoden ist es Objekten, die eine Referenz auf den Wizard besitzen, möglich, Informationen vom Wizard auszulesen. Beispielsweise bekommen alle in den Wizard eingebundenen Objekte (Navigationsbereich, Informationsbereich, Protokollbereich, Arbeitskapitel) im Zuge der Instanzierung eine Referenz des Wizards übergeben, wodurch ihnen ein Zugriff auf diese Methoden möglich ist.

Beispiele für diese GET-Methoden:

  • GET_ACTIVE_STEP
Diese Methode liefert das aktuelle aktive Arbeitskapitel zurück.
  • GET_NEXT_STEP
Diese Methode liefert das nächste Arbeitskapitel ausgehend vom aktuellen Arbeitskapitel zurück.
  • GET_PREV_STEP
Diese Methdoe liefert das vorhergehende Arbeitskapitel ausgehend vom aktuellen Arbeitskapitel zurück.
  • GET_T_STEPS
Diese Mehtode liefert eine Liste der Arbeitskapitel, welche vom Wizard selbst direkt verwaltet werden (erste Hiererarchiestufe)
  • GET_PROTOCOL
Diese Methode liefert eine Referenz auf das eingebundene Protokoll zurück.
  • GET_ROADMAP
Diese Methode liefert eine Referenz auf den eingebundenen Navigationsbereich zurück.

Beziehungen

Die abstrakte Basisklasse CL_ISHMED_WIZARD vererbt Funktionalität auf die Klassen CL_ISHMED_WIZARD_IS_EXP_BASE und CL_ISHMED_WIZARD_IS_IMP_BASE.

Beispiel

Hinweise

Weiterführende Informationen






BAL Application Log Documentation   rdisp/max_wprun_time - Maximum work process run time  
Diese Dokumentation steht unter dem Copyright der SAP AG.

Length: 5624 Date: 20240329 Time: 123414     sap01-206 ( 76 ms )