Package com.uc4.api.objects

Class XRequest

  • public class XRequest
extends UC4Object
    XREQ Object : Each X-request has an according X-request object XREQ available in the the AE database that specifies how a request is processed. The processing instructions are written in a specific script (Automic script and reserved internal functions of DSFUN). These objects are of type XREQ and exclusively stored in client 0. They are not visible for the customer an hidden in folder 0000\XREQ\. XREQ objects are part of the AE initial data (OH_Idnr lower than 100.000) and can be imported/exported via DB.LOAD/UNLOAD (uc_ini.txt).

    • Constructor Summary

      Constructors 
      Constructor Description
      XRequest()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getAct()
      Returns the script on object execution for XREQ Object
      java.lang.String getExp()
      Returns the script on exporting object of XREQ Object
      java.lang.String getGet()
      returns the script on read object of XREQ Object
      java.lang.String getGui()
      Returns the script describing the GUI structure of XREQ Object
      protected java.lang.String getScriptChildElementName()  
      java.lang.String getSet()
      returns the script on saving object of XREQ Object
      java.lang.String getXcmp()
      Returns the structure for version comparison for XREQ Object
      java.lang.String getXgui()
      Returns structure of UI definition for XREQ object
      protected java.lang.String getXmlChildElementName()  
      java.lang.String getXreq()
      Returns the X-request XML of XREQ Object
      Header header()
      Returns the header data of this object.
      boolean isExecutable()
      Returns true if this Object can be executed.
      void setAct​(java.lang.String act)
      Sets the script on object execution for XREQ Object
      void setExp​(java.lang.String exp)
      sets the script on exporting object for XREQ Object
      void setGet​(java.lang.String get)
      Sets the script on read object for XREQ Object
      void setGui​(java.lang.String gui)
      Sets the script describing the GUI structure for XREQ Object
      void setSet​(java.lang.String set)
      Sets the script on saving object for XREQ Object
      void setXcmp​(java.lang.String xcmp)
      Sets the structure for version comparison for XREQ Object
      void setXgui​(java.lang.String xgui)
      Sets structure of UI definition for XREQ object
      void setXreq​(java.lang.String xreq)
      Sets the X-request XML of XREQ Object

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • XRequest

        public XRequest()

    • Method Detail

      • getAct

        public java.lang.String getAct()
        Returns the script on object execution for XREQ Object
        Returns:
        act script on object execution

      • setAct

        public void setAct​(java.lang.String act)
        Sets the script on object execution for XREQ Object
        Parameters:
        act - script on object execution

      • getXreq

        public java.lang.String getXreq()
        Returns the X-request XML of XREQ Object
        Returns:
        xreq X-request XML

      • setXreq

        public void setXreq​(java.lang.String xreq)
        Sets the X-request XML of XREQ Object
        Parameters:
        xreq - X-request XML

      • getXcmp

        public java.lang.String getXcmp()
        Returns the structure for version comparison for XREQ Object
        Returns:
        structure for version comparison

      • setXcmp

        public void setXcmp​(java.lang.String xcmp)
        Sets the structure for version comparison for XREQ Object
        Parameters:
        xcmp - structure for version comparison

      • getXgui

        public java.lang.String getXgui()
        Returns structure of UI definition for XREQ object
        Returns:
        structure of UI definition

      • setXgui

        public void setXgui​(java.lang.String xgui)
        Sets structure of UI definition for XREQ object
        Parameters:
        xgui - structure of UI definition

      • setGui

        public void setGui​(java.lang.String gui)
        Sets the script describing the GUI structure for XREQ Object
        Parameters:
        gui - script describing the GUI structure

      • setGet

        public void setGet​(java.lang.String get)
        Sets the script on read object for XREQ Object
        Parameters:
        get - script on read object

      • setSet

        public void setSet​(java.lang.String set)
        Sets the script on saving object for XREQ Object
        Parameters:
        set - script on saving object

      • setExp

        public void setExp​(java.lang.String exp)
        sets the script on exporting object for XREQ Object
        Parameters:
        exp - script on exporting object

      • getGui

        public java.lang.String getGui()
        Returns the script describing the GUI structure of XREQ Object
        Returns:
        script describing the GUI structure

      • getGet

        public java.lang.String getGet()
        returns the script on read object of XREQ Object
        Returns:
        script on read object

      • getSet

        public java.lang.String getSet()
        returns the script on saving object of XREQ Object
        Returns:
        script on saving object

      • getExp

        public java.lang.String getExp()
        Returns the script on exporting object of XREQ Object
        Returns:
        script on exporting object

      • isExecutable

        public boolean isExecutable()
        Description copied from class: UC4Object
        Returns true if this Object can be executed.
        Specified by:
        isExecutable in class UC4Object
        Returns:
        true if the Object can be executed, false if not.

      • header

        public Header header()
        Returns the header data of this object. This is the information of the header tab in the dialog client.
        Returns:
        header

      • getScriptChildElementName

        protected java.lang.String getScriptChildElementName()

      • getXmlChildElementName

        protected java.lang.String getXmlChildElementName()