Class SystemXML

  • All Implemented Interfaces:
    java.io.Serializable

    public class SystemXML
    extends java.lang.Object
    implements java.io.Serializable
    System object APIs for integration using Simplicité XML
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      SystemXML()  
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.lang.String getBPMState​(java.lang.String listOfValues, java.lang.String state, java.lang.String label, boolean active, java.lang.String module)
      Generates XML statement for BPM state TODO: to be completed
      static java.lang.String getCrosstab​(java.lang.String name, java.lang.String object, char function, boolean grantable, boolean visible, java.util.Map<java.lang.String,​java.lang.String> translations, java.lang.String module)
      Generates XML statement for pivot table
      static java.lang.String getCrosstabAxis​(java.lang.String crosstab, java.lang.String object, java.lang.String objectField, int objectFieldOrder, char type, int order, java.lang.String module)
      Generates XML statement for pivot table axis
      static java.lang.String getCrosstabGroup​(java.lang.String crosstab, java.lang.String group, java.lang.String module)
      Generates XML statement for pivot table group
      static java.lang.String getDomain​(java.lang.String name, java.util.Map<java.lang.String,​java.lang.String> translations, java.lang.String module)
      Generates XML statement for domain TODO: to be completed
      static java.lang.String getExternalObject​(java.lang.String name, java.lang.String url, java.util.Map<java.lang.String,​java.lang.String> translations, java.lang.String module)
      Generates XML statement for external object
      static java.lang.String getField​(java.lang.String name, java.lang.String column, int type, java.lang.String typeParam, int size, int precision, boolean fctkey, boolean required, int search, int visible, boolean more, boolean listmore, char contentCase, java.lang.String defValue, java.util.Map<java.lang.String,​java.lang.String> translations, java.lang.String module)
      Generates XML statement for field TODO: to be completed
      static java.lang.String getFieldArea​(java.lang.String name, int order, java.util.Map<java.lang.String,​java.lang.String> translations, java.lang.String module)
      Generates XML statement for field area
      static java.lang.String getFieldType​(java.lang.String code, java.lang.String regexp, java.util.Map<java.lang.String,​java.lang.String> translations, java.lang.String module)
      Generates field type XML statement TODO: to be completed
      static java.lang.String getFunction​(java.lang.String name, java.lang.String object, java.lang.String function, java.lang.String action, java.lang.String view, java.lang.String module)
      Generates XML statement for function TODO: to be completed
      static java.lang.String getGrant​(java.lang.String group, java.lang.String function, boolean active, java.lang.String module)
      Generates XML statement for object grant TODO: to be completed
      static java.lang.String getGroup​(java.lang.String name, java.lang.String parent, java.lang.String comment, java.lang.String[] modes, java.lang.String module)
      Generates XML statement for group
      static java.lang.String getListOfValue​(java.lang.String name, java.lang.String code, int order, java.util.Map<java.lang.String,​java.lang.String> translations, java.lang.String module)
      Generates XML statement for single list of values entry
      static java.lang.String getListOfValues​(java.lang.String name, java.lang.String[] codes, int[] orders, java.util.Map<java.lang.String,​java.lang.String>[] translations, java.lang.String module)
      Generates XML statement for multiple list of values entries
      static java.lang.String getMap​(java.lang.String domain, java.lang.String object, java.lang.String process, int order, java.lang.String module)
      Generates XML statement for menu entry TODO: to be completed
      static java.lang.String getObject​(java.lang.String name, java.lang.String father, java.lang.String table, java.lang.String template, boolean timestamp, boolean distinct, boolean nosearch, boolean export, boolean copy, boolean pagine, boolean predefsearch, boolean updall, boolean useform, boolean refcount, boolean historic, java.lang.String defpanel, java.util.Map<java.lang.String,​java.lang.String> translations, java.lang.String module)
      Generates XML statement for business object TODO: to be completed
      static java.lang.String getObjectField​(java.lang.String object, java.lang.String field, int order, java.lang.String refObject, java.lang.String refField, java.lang.String refDelMode, java.lang.String fieldArea, java.util.Map<java.lang.String,​java.lang.String> translations, java.lang.String module)
      Generates XML statement for object field TODO: to be completed
      static java.lang.String getSysParam​(java.lang.String code, java.lang.String value, java.lang.String type, java.lang.String desc, java.lang.String module)
      Generates XML statement for single system parameter
      static java.lang.String getSysParams​(java.lang.String[] codes, java.lang.String[] values, java.lang.String[] types, java.lang.String[] descs, java.lang.String module)
      Generates XML statement for multiple system parameters
      static java.lang.String getTemplate​(java.lang.String name, java.lang.String html, java.lang.String module)
      Generates XML statement for template TODO: to be completed
      static java.lang.String getText​(java.lang.String code, java.util.Map<java.lang.String,​java.lang.String> translations, java.lang.String module)
      Generates XML statement for single text
      static java.util.Map<java.lang.String,​java.lang.String> getTranslationMap​(java.lang.String lang, java.lang.String translation)
      Get simple translation map
      static java.lang.String getView​(java.lang.String name, java.lang.String html, int order, java.util.Map<java.lang.String,​java.lang.String> translations, java.lang.String module)
      Generates XML statement for view
      static java.lang.String getViewItem​(java.lang.String view, int position, char type, boolean title, java.lang.String object, java.lang.String filter, java.lang.String searchName, java.lang.String crosstabName, java.lang.String graphName, java.lang.String printTemplateName, java.lang.String lovCode, java.lang.String url, java.lang.String image, java.util.Map<java.lang.String,​java.lang.String> translations, java.lang.String module)
      Generates XML statement for view item TODO: to be completed
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • SUPERVISOR_STATUS_LOAD_ERROR

        public static final char SUPERVISOR_STATUS_LOAD_ERROR
        Supervisor status: load error
        See Also:
        Constant Field Values
      • SUPERVISOR_STATUS_FOR_IMPORT

        public static final char SUPERVISOR_STATUS_FOR_IMPORT
        Supervisor status: for import
        See Also:
        Constant Field Values
      • SUPERVISOR_STATUS_INPROGRESS

        public static final char SUPERVISOR_STATUS_INPROGRESS
        Supervisor status: in progress
        See Also:
        Constant Field Values
      • SUPERVISOR_STATUS_IMPORT_ERROR

        public static final char SUPERVISOR_STATUS_IMPORT_ERROR
        Supervisor status: import error
        See Also:
        Constant Field Values
      • SUPERVISOR_STATUS_IMPORT_OK

        public static final char SUPERVISOR_STATUS_IMPORT_OK
        Supervisor status: import KO
        See Also:
        Constant Field Values
      • SUPERVISOR_STATUS_CANCELLED

        public static final char SUPERVISOR_STATUS_CANCELLED
        Supervisor status: cancelled
        See Also:
        Constant Field Values
    • Constructor Detail

      • SystemXML

        public SystemXML()
    • Method Detail

      • getTranslationMap

        public static java.util.Map<java.lang.String,​java.lang.String> getTranslationMap​(java.lang.String lang,
                                                                                               java.lang.String translation)
        Get simple translation map
        Parameters:
        lang - Language
        translation - Translation
        Returns:
        Translation map
      • getSysParams

        public static java.lang.String getSysParams​(java.lang.String[] codes,
                                                    java.lang.String[] values,
                                                    java.lang.String[] types,
                                                    java.lang.String[] descs,
                                                    java.lang.String module)
                                             throws XMLException
        Generates XML statement for multiple system parameters
        Parameters:
        codes - System parameter codes
        values - System parameter values
        types - System parameter types (can be null, then "APP" will be used)
        descs - System parameter descriptions (can be null)
        module - Module
        Returns:
        XML statement
        Throws:
        XMLException - If XML generation fails
      • getSysParam

        public static java.lang.String getSysParam​(java.lang.String code,
                                                   java.lang.String value,
                                                   java.lang.String type,
                                                   java.lang.String desc,
                                                   java.lang.String module)
                                            throws XMLException
        Generates XML statement for single system parameter
        Parameters:
        code - System parameter code
        value - System parameter value
        type - System parameter type (can be null, then "APP" will be used)
        desc - System parameter description (can be null)
        Returns:
        XML statement
        Throws:
        XMLException - If XML generation fails
      • getListOfValues

        public static java.lang.String getListOfValues​(java.lang.String name,
                                                       java.lang.String[] codes,
                                                       int[] orders,
                                                       java.util.Map<java.lang.String,​java.lang.String>[] translations,
                                                       java.lang.String module)
                                                throws XMLException
        Generates XML statement for multiple list of values entries
        Parameters:
        name - List of values name
        codes - list of values entries codes
        orders - list of values entries orders (can be null, then list of values orders are generated starting at 1)
        translations - List of values entries translations
        module - Module
        Returns:
        XML statement
        Throws:
        XMLException - If XML generation fails
      • getListOfValue

        public static java.lang.String getListOfValue​(java.lang.String name,
                                                      java.lang.String code,
                                                      int order,
                                                      java.util.Map<java.lang.String,​java.lang.String> translations,
                                                      java.lang.String module)
                                               throws XMLException
        Generates XML statement for single list of values entry
        Parameters:
        name - List of values name
        code - list of values entry code
        order - list of values entry order
        translations - List of values entry translations
        module - Module
        Returns:
        XML statement
        Throws:
        XMLException - If XML generation fails
      • getText

        public static java.lang.String getText​(java.lang.String code,
                                               java.util.Map<java.lang.String,​java.lang.String> translations,
                                               java.lang.String module)
                                        throws XMLException
        Generates XML statement for single text
        Parameters:
        code - Text code
        translations - Text translations
        module - Module name
        Returns:
        XML statement
        Throws:
        XMLException - If XML generation fails
      • getDomain

        public static java.lang.String getDomain​(java.lang.String name,
                                                 java.util.Map<java.lang.String,​java.lang.String> translations,
                                                 java.lang.String module)
                                          throws XMLException
        Generates XML statement for domain TODO: to be completed
        Parameters:
        module - Module name
        Returns:
        XML statement
        Throws:
        XMLException - If XML generation fails
      • getTemplate

        public static java.lang.String getTemplate​(java.lang.String name,
                                                   java.lang.String html,
                                                   java.lang.String module)
                                            throws XMLException
        Generates XML statement for template TODO: to be completed
        Parameters:
        module - Module name
        Returns:
        XML statement
        Throws:
        XMLException - If XML generation fails
      • getObject

        public static java.lang.String getObject​(java.lang.String name,
                                                 java.lang.String father,
                                                 java.lang.String table,
                                                 java.lang.String template,
                                                 boolean timestamp,
                                                 boolean distinct,
                                                 boolean nosearch,
                                                 boolean export,
                                                 boolean copy,
                                                 boolean pagine,
                                                 boolean predefsearch,
                                                 boolean updall,
                                                 boolean useform,
                                                 boolean refcount,
                                                 boolean historic,
                                                 java.lang.String defpanel,
                                                 java.util.Map<java.lang.String,​java.lang.String> translations,
                                                 java.lang.String module)
                                          throws XMLException
        Generates XML statement for business object TODO: to be completed
        Parameters:
        module - Module name
        Returns:
        XML statement
        Throws:
        XMLException - If XML generation fails
      • getFieldType

        public static java.lang.String getFieldType​(java.lang.String code,
                                                    java.lang.String regexp,
                                                    java.util.Map<java.lang.String,​java.lang.String> translations,
                                                    java.lang.String module)
                                             throws XMLException
        Generates field type XML statement TODO: to be completed
        Parameters:
        module - Module name
        Returns:
        XML statement
        Throws:
        XMLException - If XML generation fails
      • getField

        public static java.lang.String getField​(java.lang.String name,
                                                java.lang.String column,
                                                int type,
                                                java.lang.String typeParam,
                                                int size,
                                                int precision,
                                                boolean fctkey,
                                                boolean required,
                                                int search,
                                                int visible,
                                                boolean more,
                                                boolean listmore,
                                                char contentCase,
                                                java.lang.String defValue,
                                                java.util.Map<java.lang.String,​java.lang.String> translations,
                                                java.lang.String module)
                                         throws XMLException
        Generates XML statement for field TODO: to be completed
        Parameters:
        module - Module name
        Returns:
        XML statement
        Throws:
        XMLException - If XML generation fails
      • getFieldArea

        public static java.lang.String getFieldArea​(java.lang.String name,
                                                    int order,
                                                    java.util.Map<java.lang.String,​java.lang.String> translations,
                                                    java.lang.String module)
                                             throws XMLException
        Generates XML statement for field area
        Parameters:
        name - Field area name
        order - Field area order
        translations - Field area tran,slations
        module - Module name
        Returns:
        XML statement
        Throws:
        XMLException - If XML generation fails
      • getObjectField

        public static java.lang.String getObjectField​(java.lang.String object,
                                                      java.lang.String field,
                                                      int order,
                                                      java.lang.String refObject,
                                                      java.lang.String refField,
                                                      java.lang.String refDelMode,
                                                      java.lang.String fieldArea,
                                                      java.util.Map<java.lang.String,​java.lang.String> translations,
                                                      java.lang.String module)
                                               throws XMLException
        Generates XML statement for object field TODO: to be completed
        Parameters:
        module - Module name
        Returns:
        XML statement
        Throws:
        XMLException - If XML generation fails
      • getGroup

        public static java.lang.String getGroup​(java.lang.String name,
                                                java.lang.String parent,
                                                java.lang.String comment,
                                                java.lang.String[] modes,
                                                java.lang.String module)
                                         throws XMLException
        Generates XML statement for group
        Parameters:
        name - Group name
        parent - Parent group name (can be null)
        comment - Comment (can be null)
        modes - Modes Array of modes (can be null, then all modes are set)
        module - Module name
        Returns:
        XML statement
        Throws:
        XMLException - If XML generation fails
      • getFunction

        public static java.lang.String getFunction​(java.lang.String name,
                                                   java.lang.String object,
                                                   java.lang.String function,
                                                   java.lang.String action,
                                                   java.lang.String view,
                                                   java.lang.String module)
                                            throws XMLException
        Generates XML statement for function TODO: to be completed
        Parameters:
        module - Module name
        Returns:
        XML statement
        Throws:
        XMLException - If XML generation fails
      • getGrant

        public static java.lang.String getGrant​(java.lang.String group,
                                                java.lang.String function,
                                                boolean active,
                                                java.lang.String module)
                                         throws XMLException
        Generates XML statement for object grant TODO: to be completed
        Parameters:
        module - Module name
        Returns:
        XML statement
        Throws:
        XMLException - If XML generation fails
      • getMap

        public static java.lang.String getMap​(java.lang.String domain,
                                              java.lang.String object,
                                              java.lang.String process,
                                              int order,
                                              java.lang.String module)
                                       throws XMLException
        Generates XML statement for menu entry TODO: to be completed
        Parameters:
        module - Module name
        Returns:
        XML statement
        Throws:
        XMLException - If XML generation fails
      • getCrosstab

        public static java.lang.String getCrosstab​(java.lang.String name,
                                                   java.lang.String object,
                                                   char function,
                                                   boolean grantable,
                                                   boolean visible,
                                                   java.util.Map<java.lang.String,​java.lang.String> translations,
                                                   java.lang.String module)
                                            throws XMLException
        Generates XML statement for pivot table
        Parameters:
        name - Pivot table name
        object - Object name
        function - Function (one of Crosstab.METHOD_* constant)
        grantable - Grantable ?
        visible - Visible ?
        translations - Translations
        module - Module name
        Returns:
        XML statement
        Throws:
        XMLException - If XML generation fails
      • getCrosstabAxis

        public static java.lang.String getCrosstabAxis​(java.lang.String crosstab,
                                                       java.lang.String object,
                                                       java.lang.String objectField,
                                                       int objectFieldOrder,
                                                       char type,
                                                       int order,
                                                       java.lang.String module)
                                                throws XMLException
        Generates XML statement for pivot table axis
        Parameters:
        crosstab - Pivot table name
        object - Object name
        objectField - Object field name
        objectFieldOrder - Object field order
        type - Axis type (one of Crosstab.AXIS_* constant)
        order - Axis order
        module - Module name
        Returns:
        XML statement
        Throws:
        XMLException - If XML generation fails
      • getCrosstabGroup

        public static java.lang.String getCrosstabGroup​(java.lang.String crosstab,
                                                        java.lang.String group,
                                                        java.lang.String module)
                                                 throws XMLException
        Generates XML statement for pivot table group
        Parameters:
        crosstab - Pivot table name
        group - Group name
        module - Module name
        Returns:
        XML statement
        Throws:
        XMLException - If XML generation fails
      • getExternalObject

        public static java.lang.String getExternalObject​(java.lang.String name,
                                                         java.lang.String url,
                                                         java.util.Map<java.lang.String,​java.lang.String> translations,
                                                         java.lang.String module)
                                                  throws XMLException
        Generates XML statement for external object
        Parameters:
        name - External object name
        url - External object URL
        translations - External object translations
        module - Module name
        Returns:
        XML statement
        Throws:
        XMLException - If XML generation fails
      • getView

        public static java.lang.String getView​(java.lang.String name,
                                               java.lang.String html,
                                               int order,
                                               java.util.Map<java.lang.String,​java.lang.String> translations,
                                               java.lang.String module)
                                        throws XMLException
        Generates XML statement for view
        Parameters:
        name - View name
        html - View HTML
        order - View order
        translations - View =translations
        module - Module name
        Returns:
        XML statement
        Throws:
        XMLException - If XML generation fails
      • getViewItem

        public static java.lang.String getViewItem​(java.lang.String view,
                                                   int position,
                                                   char type,
                                                   boolean title,
                                                   java.lang.String object,
                                                   java.lang.String filter,
                                                   java.lang.String searchName,
                                                   java.lang.String crosstabName,
                                                   java.lang.String graphName,
                                                   java.lang.String printTemplateName,
                                                   java.lang.String lovCode,
                                                   java.lang.String url,
                                                   java.lang.String image,
                                                   java.util.Map<java.lang.String,​java.lang.String> translations,
                                                   java.lang.String module)
                                            throws XMLException
        Generates XML statement for view item TODO: to be completed
        Parameters:
        module - Module name
        Returns:
        XML statement
        Throws:
        XMLException - If XML generation fails
      • getBPMState

        public static java.lang.String getBPMState​(java.lang.String listOfValues,
                                                   java.lang.String state,
                                                   java.lang.String label,
                                                   boolean active,
                                                   java.lang.String module)
                                            throws XMLException
        Generates XML statement for BPM state TODO: to be completed
        Parameters:
        module - Module name
        Returns:
        XML statement
        Throws:
        XMLException