com.ibm.tivoli.maximo.interaction.generate

Class DialogGenerator

  • java.lang.Object
    • com.ibm.tivoli.maximo.interaction.generate.DialogGenerator


  • public class DialogGenerator
    extends java.lang.Object
    Dialog Generator.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static MXLogger INTERACTIONLOGGER
      Interaction logger for logging messages related to Interaction.
    • Constructor Summary

      Constructors 
      Constructor and Description
      DialogGenerator()
      Construct generator
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      boolean findAction(org.jdom2.Document doc, java.lang.String appName, java.lang.String actionId)
      Find action by id.
      java.util.List findChildren(MboSetRemote set, java.lang.String relation, java.lang.String hierarchyPath)
      Add support for workflow to the application named by this Mbo.
      boolean findDialog(org.jdom2.Document doc, java.lang.String appName, java.lang.String dialogID)
      Find Dialog by id.
      boolean findElementByID(org.jdom2.Element in, java.lang.String inid)
      Find Element by ID.
      java.lang.String generateDialog(MboRemote intGenerator, byte[] presentataion)
      Generate dialog based in IntGenerator Mbo.
      java.lang.String generateUniqueID()
      Generate unique ID for attribute ID return unique id
      org.jdom2.Document getAppXML(java.lang.String app, UserInfo userInfo)
      Get Application XML from MAXPRESENTATION table.
      java.lang.String getFileName(java.lang.String inter, java.lang.String name)
      Get the full path and file name based on given message data.
      java.lang.String removeDialog(org.jdom2.Document doc, java.lang.String dialogID)
      Remove dialog from presentataion.
      void setLookup(org.jdom2.Element data, java.lang.String type)
      Set domain lookup in presentataion.
      • Methods inherited from class java.lang.Object

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

      • INTERACTIONLOGGER

        public static final MXLogger INTERACTIONLOGGER
        Interaction logger for logging messages related to Interaction.
    • Constructor Detail

      • DialogGenerator

        public DialogGenerator()
        Construct generator
        Throws:
        MXException - MAXIMO exception
        java.rmi.RemoteException - Remote exception
    • Method Detail

      • generateDialog

        public java.lang.String generateDialog(MboRemote intGenerator,
                                               byte[] presentataion)
                                        throws java.rmi.RemoteException,
                                               MXException
        Generate dialog based in IntGenerator Mbo.
        Parameters:
        intGenerator - Give reference to generator Mbo.
        Throws:
        MXException - MAXIMO exception
        java.rmi.RemoteException - Remote exception
      • getAppXML

        public org.jdom2.Document getAppXML(java.lang.String app,
                                            UserInfo userInfo)
                                     throws java.rmi.RemoteException,
                                            MXException
        Get Application XML from MAXPRESENTATION table.
        Parameters:
        app - name of an application
        userInfo - UserInfo object
        Throws:
        MXException - MAXIMO exception
        java.rmi.RemoteException - Remote exception
      • removeDialog

        public java.lang.String removeDialog(org.jdom2.Document doc,
                                             java.lang.String dialogID)
                                      throws java.rmi.RemoteException,
                                             MXException
        Remove dialog from presentataion.
        Parameters:
        doc - Document to find dialog
        dialogID - dialog id
        Throws:
        MXException - MAXIMO exception
        java.rmi.RemoteException - Remote exception
      • findDialog

        public boolean findDialog(org.jdom2.Document doc,
                                  java.lang.String appName,
                                  java.lang.String dialogID)
                           throws java.rmi.RemoteException,
                                  MXException
        Find Dialog by id.
        Parameters:
        doc - Document to find dialog
        appName - application name
        dialogID - dialog id
        Throws:
        MXException - MAXIMO exception
        java.rmi.RemoteException - Remote exception
      • findElementByID

        public boolean findElementByID(org.jdom2.Element in,
                                       java.lang.String inid)
                                throws java.rmi.RemoteException,
                                       MXException
        Find Element by ID.
        Parameters:
        in - Element to serach
        inid - id to find
        Throws:
        MXException - MAXIMO exception
        java.rmi.RemoteException - Remote exception
      • findAction

        public boolean findAction(org.jdom2.Document doc,
                                  java.lang.String appName,
                                  java.lang.String actionId)
                           throws java.rmi.RemoteException,
                                  MXException
        Find action by id.
        Parameters:
        doc - Document to find dialog
        appName - application name
        actionId - action id
        Throws:
        MXException - MAXIMO exception
        java.rmi.RemoteException - Remote exception
      • findChildren

        public java.util.List findChildren(MboSetRemote set,
                                           java.lang.String relation,
                                           java.lang.String hierarchyPath)
                                    throws java.rmi.RemoteException,
                                           MXException
        Add support for workflow to the application named by this Mbo. Does nothing if the AddSupport attribute is cleared.
        Parameters:
        set - reference to MboSet
        relation - relationship name
        hierarchyPath - hierarchy path
        Throws:
        MXException - MAXIMO exception
        java.rmi.RemoteException - Remote exception
      • setLookup

        public void setLookup(org.jdom2.Element data,
                              java.lang.String type)
                       throws java.rmi.RemoteException,
                              MXException
        Set domain lookup in presentataion.
        Parameters:
        data - Element to serach
        type - domain type
        Throws:
        MXException - MAXIMO exception
        java.rmi.RemoteException - Remote exception
      • generateUniqueID

        public java.lang.String generateUniqueID()
        Generate unique ID for attribute ID return unique id
      • getFileName

        public java.lang.String getFileName(java.lang.String inter,
                                            java.lang.String name)
                                     throws MXException
        Get the full path and file name based on given message data.
        Parameters:
        inter - Interaction Name
        name - file Name
        Returns:
        Full path and file name of message file.
        Throws:
        MXException