Package com.uc4.api.objects
Class XRequest
java.lang.Object
com.uc4.api.objects.UC4Object
com.uc4.api.objects.XRequest
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 -
Method Summary
Modifier and TypeMethodDescriptiongetAct()
Returns the script on object execution for XREQ ObjectgetExp()
Returns the script on exporting object of XREQ ObjectgetGet()
returns the script on read object of XREQ ObjectgetGui()
Returns the script describing the GUI structure of XREQ Objectprotected String
getSet()
returns the script on saving object of XREQ ObjectgetXcmp()
Returns the structure for version comparison for XREQ ObjectgetXgui()
Returns structure of UI definition for XREQ objectprotected String
getXreq()
Returns the X-request XML of XREQ Objectheader()
Returns the header data of this object.boolean
Returnstrue
if this Object can be executed.void
Sets the script on object execution for XREQ Objectvoid
sets the script on exporting object for XREQ Objectvoid
Sets the script on read object for XREQ Objectvoid
Sets the script describing the GUI structure for XREQ Objectvoid
Sets the script on saving object for XREQ Objectvoid
Sets the structure for version comparison for XREQ Objectvoid
Sets structure of UI definition for XREQ objectvoid
Sets the X-request XML of XREQ ObjectMethods inherited from class com.uc4.api.objects.UC4Object
docu, getAccess, getIdnr, getModCount, getName, getObjectClient, getType, isOldVersion, load, store, validate
-
Constructor Details
-
XRequest
public XRequest()
-
-
Method Details
-
getAct
Returns the script on object execution for XREQ Object- Returns:
- act script on object execution
-
setAct
Sets the script on object execution for XREQ Object- Parameters:
act
- script on object execution
-
getXreq
Returns the X-request XML of XREQ Object- Returns:
- xreq X-request XML
-
setXreq
Sets the X-request XML of XREQ Object- Parameters:
xreq
- X-request XML
-
getXcmp
Returns the structure for version comparison for XREQ Object- Returns:
- structure for version comparison
-
setXcmp
Sets the structure for version comparison for XREQ Object- Parameters:
xcmp
- structure for version comparison
-
getXgui
Returns structure of UI definition for XREQ object- Returns:
- structure of UI definition
-
setXgui
Sets structure of UI definition for XREQ object- Parameters:
xgui
- structure of UI definition
-
setGui
Sets the script describing the GUI structure for XREQ Object- Parameters:
gui
- script describing the GUI structure
-
setGet
Sets the script on read object for XREQ Object- Parameters:
get
- script on read object
-
setSet
Sets the script on saving object for XREQ Object- Parameters:
set
- script on saving object
-
setExp
sets the script on exporting object for XREQ Object- Parameters:
exp
- script on exporting object
-
getGui
Returns the script describing the GUI structure of XREQ Object- Returns:
- script describing the GUI structure
-
getGet
returns the script on read object of XREQ Object- Returns:
- script on read object
-
getSet
returns the script on saving object of XREQ Object- Returns:
- script on saving object
-
getExp
Returns the script on exporting object of XREQ Object- Returns:
- script on exporting object
-
isExecutable
public boolean isExecutable()Description copied from class:UC4Object
Returnstrue
if this Object can be executed.- Specified by:
isExecutable
in classUC4Object
- Returns:
- true if the Object can be executed, false if not.
-
header
Returns the header data of this object. This is the information of the header tab in the dialog client.- Returns:
- header
-
getScriptChildElementName
-
getXmlChildElementName
-