Package de.xima.fc.web.common.fd2.model

Class DefaultFD2MetaDataWrapper

  • All Implemented Interfaces:
    Serializable
    public class DefaultFD2MetaDataWrapper
extends AMetaDataWrapper
    Diese Klasse kapselt ein Script-Objekt welches als Node im einem HTML-Generierungsprozess eingebunden werden kann. Primär zielt diese Klasse darauf ab Meta-Informationen zum aktuellen Benutzer, BenutzerGruppen, Vorgang sowie URL-Parameter und Plugins in ein Formular einzubinden, wenn dieses über das Form-Servlet aufgerufen wird. Ist der IFormRequestContext null, so werden die JSONObjecte welche den Kontext benötigen nicht angefügt. Gleiches gilt die Maps, die als Grundlage für die JSONObject-Generierung dienen
    Author:
    XIMA MEDIA GmbH
    See Also:
    Serialized Form

    • Constructor Detail

      • DefaultFD2MetaDataWrapper

        public DefaultFD2MetaDataWrapper​(IFormRenderContext renderCtx)
        Konstruktor mit allen benötigten Objekten um den vollen Funktionsumfang der Klasse zu gewährleisten. Alle Parameter können als null übergeben werden. Die Teile, welche dann auf ein solches Element zu greifen prüfen dies und erzeugen ggf. keine Daten. Die JSON-Objekte würde dann nicht hinzugefügt werden.
        Parameters:
        renderCtx - der IFormRenderContext der mit dem Abfragen eines Formulars erzeugt wird und entsprechende Sitzungsdaten beinhaltet

      • DefaultFD2MetaDataWrapper

        public DefaultFD2MetaDataWrapper​(String scriptName,
                                 IFormRenderContext renderCtx)
        Konstruktor mit allen benötigten Objekten um den vollen Funktionsumfang der Klasse zu gewährleisten. Alle Parameter können als null übergeben werden. Die Teile, welche dann auf ein solches Element zu greifen prüfen dies und erzeugen ggf. keine Daten. Die JSON-Objekte würde dann nicht hinzugefügt werden.
        Parameters:
        scriptName - Name unter dem der Knoten referenzierbar ist
        renderCtx - der IFormRenderContext der mit dem Abfragen eines Formulars erzeugt wird und entsprechende Sitzungsdaten beinhaltet

      • DefaultFD2MetaDataWrapper

        public DefaultFD2MetaDataWrapper​(String scriptName,
                                 IFormRenderContext renderCtx,
                                 boolean build)

    • Method Detail

      • buildInnerJSON

        protected com.alibaba.fastjson.JSONObject buildInnerJSON​(IFormRenderContext renderCtx)
        Diese Methode fügt die Basiselemente als JSONObject dem FormMetaData-Objekt hinzu. Sollen zusätzliche Elemente hinzugefügt werden, so kann diese Methode überschieben bzw. erweitert werden.

      • createURLs

        protected com.alibaba.fastjson.JSONObject createURLs​(IFormRenderContext renderCtx)

      • createCurrentMandant

        protected com.alibaba.fastjson.JSONObject createCurrentMandant​(IFormRenderContext renderCtx)

      • createUser

        protected com.alibaba.fastjson.JSONObject createUser​(IFormRenderContext renderCtx)
        Diese Methode erzeugt das JSONObject für den aktuell im IFormRequestContext befindlichen Benutzer
        Returns:
        JSONObject mit Daten des Benutzers (inklusive zugeordneten BenutzerGruppen als JSONArray) oder null wenn Benutzer im Kontext nicht vorhanden oder eine JSONException auftritt

      • createCurrentVorgang

        protected com.alibaba.fastjson.JSONObject createCurrentVorgang​(IFormRenderContext renderCtx)
        Diese Methode erzeugt das JSONObject für den aktuell im IFormRequestContext befindlichen Vorgang
        Returns:
        JSONObject mit Daten des Vorgangs oder null wenn Vorgang im Kontext nicht vorhanden oder eine JSONException auftritt

      • createAttachmentsData

        protected com.alibaba.fastjson.JSONArray createAttachmentsData​(IFormRenderContext renderCtx)
        Returns:
        A JSON array with all attachments.

      • createCurrentProjekt

        protected com.alibaba.fastjson.JSONObject createCurrentProjekt​(IFormRenderContext renderCtx)
        Diese Methode erzeugt das JSONObject für den aktuell im IFormRequestContext befindlichen Projekt
        Returns:
        JSONObject mit Daten des Projekts oder null wenn Projekt im Kontext nicht vorhanden oder eine JSONException auftritt

      • createServerValidationErrors

        protected com.alibaba.fastjson.JSONObject createServerValidationErrors​(IFormRenderContext renderCtx)

      • createUrlParams

        protected com.alibaba.fastjson.JSONObject createUrlParams​(IFormRenderContext renderCtx)
        Diese Methode erzeugt ein JSONObject aus URL-Parametern. Es wird hierbei ein einziges JSONObject erzeugt welches die URL-Parameter als Key-Value-Paar beinhaltet. Ergibt sich der Value aus einem Array, so wird das erste Element des Arrays als Value genutzt. Ist kein Value vorhanden oder besteht der Value aus einem Leerstring, so wird der Parameter dem JSONObject nicht hinzugefügt
        Returns:
        JSONObject mit URL-Parametern als Key-Value-Paar. null wenn eine JSONException auftritt oder die Map der URL-Paramter null bzw. leer ist.

      • createPluginResults

        protected com.alibaba.fastjson.JSONObject createPluginResults​(IFormRenderContext renderCtx)
        Diese Methode erzeugt ein JSONObject welches die Plugin-Informationen als JSONObject beinhaltet. Das umschließende JSONObject kann mehrere andere JSONObjecte beinhalten, welche wiederum mir Key-Value-Paaren befüllt sind.
        Returns:
        JSONObject mit Plugin-Informationen oder null wenn ein JSONException auftritt bzw. die Map mit den Plugin-Informationen leer bzw. null ist.

      • buildDataMap

        protected Map<String,​List<String[]>> buildDataMap​(IFormRenderContext renderCtx)
        Diese Methode liefert eine Map als Vereinigungsmenge aus valuesMap und urlParams. Hierbei wird eine neue Map erzeugt und zurückgeliefert.
        Returns:
        eine Map bestehend aus valuesMap und urlParams oder eine leere Map wenn keine Daten vorhanden.

      • createUserGroupsArray

        @Deprecated
protected com.alibaba.fastjson.JSONArray createUserGroupsArray​(IFormRenderContext renderCtx)
        Deprecated.

      • determineLdapUserProperties

        @Deprecated
protected com.alibaba.fastjson.JSONObject determineLdapUserProperties​(IFormRenderContext renderCtx)
        Deprecated.