Dokumentation Übersicht |
 |
WebAG Automat 5.0
|
Formularsystem 2.0
Formularsystem - API
Inhaltsverzeichnis
Zugriff auf XML-Dokumente
Zugriff auf Container und Treiber
Zugriff auf Formular-Elemente
Darstellen von Formular-Elementen
1. wt_form_api
1.1 Zugriff auf XML-Dokumente
Formulardaten werden in einem XML-Container in der Datenbank gespeichert. Um diesen Container zu initialisieren oder zu speichern gibt es zwei Zugriffsprozeduren.
1.1.1 init_xml
Diese Prozedur liefert zu einem XML Dokument welches in Form eines CLOBs vorliegt das zur Weiterverarbeitung benötigte XML DOMDocument Modell zurück.
PROCEDURE init_xml (
i_xml_data IN CLOB,
o_xml_domdocument OUT NOCOPY xmldom.DOMDocument
);Auf dem DOMDocument werden die Formular-Elementzugriffe ausgeführt.
1.1.2 save_xml
Diese Prozedur speichert das DOMDocument Modell zurück in den Formularcontainer.
PROCEDURE save_xml (
i_form_container_id IN NUMBER DEFAULT NULL,
i_DOMDocument IN xmldom.DOMDocument
);
1.2 Zugriff auf Container und Treiber
Formulardaten werden in einem XML-Container in der Datenbank gespeichert, die Formularverarbeitung wird im Formulartreiber festgelegt. Um diesen Container neu anzulegen oder zu holen gibt es zwei Zugriffsprozeduren (init_form_container und get_form_container). Der Formulartreiber wird mit get_form_driver abgefragt.
1.2.1 init_form_container
Diese Prozedur initialisiert einen neuen Formular-Container in dem die eingegebenen Daten in Form eines XML-Dokuments gespeichert werden.
PROCEDURE init_form_container (
i_form_driver_id IN NUMBER DEFAULT NULL,
o_form_container_id OUT NUMBER
);
1.2.2 get_form_container
Diese Prozedur holt einen Formular-Container mit dem XML-Dokument der eingegebenen Daten.
PROCEDURE get_form_container (
i_form_id IN NUMBER DEFAULT NULL,
i_form_container_id IN NUMBER DEFAULT NULL,
o_form_container_rec OUT NOCOPY wt_form_container%ROWTYPE
);
1.2.3 get_form_driver
Diese Function holt zu einem Parameter des Formular-Treibers dessen Wert.
FUNCTION get_form_driver (
i_form_driver_id IN NUMBER DEFAULT NULL,
i_form_container_id IN NUMBER DEFAULT NULL,
i_parameter_name IN VARCHAR2 DEFAULT NULL
)
RETURN VARCHAR2;
1.3 Zugriff auf Formular-Elemente
Zum lesen bzw. schreiben vom Formularwerten dienen die Functions get_element_value und set_element_value. Beim Schreiben ist zu beachten, daß zur Speicherung in die Datenbank das XML-Dokument mit save_xml gespeichert werden muß.
1.3.1 get_element_value
Diese Function holt zu einem Formular-Element dessen Wert.
FUNCTION get_element_value (
i_element_id IN NUMBER DEFAULT NULL,
i_list_row IN NUMBER DEFAULT NULL,
i_get_value IN NUMBER DEFAULT wt.db_no,
i_DOMDocument IN xmldom.DOMDocument DEFAULT NULL
)
RETURN VARCHAR2;
1.3.2 set_element_value
Diese Prozedur setzt zu einem Formular-Element einen Wert.
PROCEDURE set_element_value (
i_element_id IN NUMBER DEFAULT NULL,
i_element_name IN VARCHAR2 DEFAULT NULL,
i_value IN VARCHAR2 DEFAULT NULL,
i_input_type IN NUMBER DEFAULT NULL,
i_list_row IN NUMBER DEFAULT NULL,
i_DOMDocument IN xmldom.DOMDocument
);
1.4 Darstellung von Formular-Elementen
Formularelemente umfaßen alles vom öffnen eines Formulars über Eingabefelder, Checkboxen etc, Listen bis hin zum schliessen eines Formulars.
1.4.1 form_open
Diese Function öffnet einen Formularbereich. Der Formularbereich muß mit form_close geschlossen werden. Formular-Elemente müssen innerhalb dieses Bereiches liegen.
FUNCTION form_open (
i_form_id IN NUMBER DEFAULT NULL,
i_form_driver_id IN NUMBER DEFAULT NULL,
i_form_container_id IN NUMBER DEFAULT NULL
)
RETURN VARCHAR2;
1.4.2 form_close
Diese Function schließt einen Formularbereich. Der Formularbereich muß mit form_open geöffnet worden sein. Formular-Elemente müssen innerhalb dieses Bereiches liegen.
FUNCTION form_close (
i_form_container_id IN NUMBER DEFAULT NULL
)
RETURN VARCHAR2;
1.4.3 form_attribut
Diese Function holt ein Attribut zu einem Formular-Element.
FUNCTION form_attribut (
i_element_id IN NUMBER DEFAULT NULL,
i_element_name IN VARCHAR2 DEFAULT NULL,
i_option_element IN NUMBER DEFAULT NULL,
i_element_attr IN VARCHAR2 DEFAULT NULL,
i_DOMDocument IN xmldom.DOMDocument DEFAULT NULL
)
RETURN VARCHAR2;
1.4.4 form_element
Diese Function stellt ein Formular-Element da.
FUNCTION form_element (
i_form_container_id IN NUMBER DEFAULT NULL,
i_form_seq_id IN NUMBER DEFAULT NULL,
i_element_id IN NUMBER DEFAULT NULL,
i_element_name IN VARCHAR2 DEFAULT NULL,
i_element_label IN VARCHAR2 DEFAULT NULL,
i_option_element IN NUMBER DEFAULT NULL,
i_list_id IN NUMBER DEFAULT NULL,
i_list_row IN NUMBER DEFAULT NULL,
i_DOMDocument IN xmldom.DOMDocument DEFAULT NULL
)
RETURN VARCHAR2;
1.4.5 form_list
Diese Prozedur initialisiert eine Liste. Die Elemente der Liste müssen innerhalb einer Schleife (LOOP) liegen.
PROCEDURE form_list (
i_list_id IN NUMBER DEFAULT NULL,
i_list_name IN VARCHAR2 DEFAULT NULL,
i_DOMDocument IN xmldom.DOMDocument DEFAULT NULL,
o_list_id OUT NUMBER,
o_list_size OUT NUMBER,
o_list_max_size OUT NUMBER
);
1.4.6 Formular-Listen und -Schaltflächen
Unter Formular-Schaltflächen versteht man Buttons zum abspeichern, löschen, abschicken sowie verwerfen einer Formulareingabe sowie die Vorwärts- und Rückwärtsnavigation.
Unter Listen-Schaltflächen versteht man die hinzufüge- und lösch-Buttons am Ende einer Listenzeile.
1.4.6.1 form_row_apply_button
Diese Function stellt den Apply-Button (Abspeichern und Einfügen) einer Listenzeile da.
FUNCTION form_row_apply_button (
i_form_container_id IN NUMBER DEFAULT NULL,
i_list_id IN NUMBER DEFAULT NULL,
i_row_id IN NUMBER DEFAULT NULL
)
RETURN VARCHAR2;
1.4.6.2 form_row_delete_button
Diese Function stellt den Delete-Button (Löschen) einer Listenzeile da.
FUNCTION form_row_delete_button (
i_form_container_id IN NUMBER DEFAULT NULL,
i_list_id IN NUMBER DEFAULT NULL,
i_row_id IN NUMBER DEFAULT NULL
)
RETURN VARCHAR2;
1.4.6.3 form_apply_button
Diese Function stellt den Apply-Button (Speichern) eines Formulars da.
FUNCTION form_apply_button (
i_form_container_id IN NUMBER DEFAULT NULL
)
RETURN VARCHAR2;
1.4.6.4 form_submit_button
Diese Function stellt den Submit-Button (Abschicken) eines Formulars da.
FUNCTION form_submit_button (
i_form_container_id IN NUMBER DEFAULT NULL
)
RETURN VARCHAR2;
1.4.6.5 form_delete_button
Diese Function stellt den Delete-Button (Löschen) eines Formlars da.
FUNCTION form_delete_button (
i_form_container_id IN NUMBER DEFAULT NULL
)
RETURN VARCHAR2;
1.4.6.6 form_cancel_button
Diese Function stellt den Cancel-Button (Abbrechen) eines Formulars da.
FUNCTION form_cancel_button (
i_form_container_id IN NUMBER DEFAULT NULL
)
RETURN VARCHAR2;
1.4.6.7 form_previous_button
Diese Function stellt den Zurück-Button in der Sub-Form Navigation eines Formulars da.
FUNCTION form_previous_button (
i_form_container_id IN NUMBER DEFAULT NULL
)
RETURN VARCHAR2;
1.4.6.8 form_next_button
Diese Function stellt den Vor-Button in der Sub-Form Navigation eines Formulars da.
FUNCTION form_next_button (
i_form_container_id IN NUMBER DEFAULT NULL
)
RETURN VARCHAR2
WebAG Automat Dokumentation
Copyright © Enterprise Web AG.
Alle Rechte vorbehalten.