Package de.elo.ix.client

Class ExecuteScriptParams

java.lang.Object
de.elo.ix.client.ExecuteScriptParams
All Implemented Interfaces:
Serializable
public class ExecuteScriptParams extends Object implements Serializable
This class is used to specify which script has to be executed in function executeScript. The script has to be an ELO Windows CLIENT OLE-Automation script.
See Also:

  • Field Details

    • scriptEngine

      protected String scriptEngine
      This value defines the scripting engine to be used to execute the script. Currently, this value must be null or empty or "EloixAuto". If the value is null or empty, EloixAuto is used by default.

    • scriptCode

      protected FileData scriptCode
      This object contains the script code to be executed as a byte array. The FileData.contentType is either "text/javascript" or "text/vbscript". FileData.data has to be encoded in UTF-8. The scriptCode.data length must be less or equal than 65535. If this member is set, the members scriptString and scriptObjId should be null.
      See Also:

    • scriptString

      protected String scriptString
      This object contains the script code to be executed as a string object. The string must either start with "javascript:" or "vbscript:". The maximum scriptString length is 65535 UTF-8 characters. If this member is set, the members scriptCode and scriptObjId should be null.

    • scriptObjId

      protected String scriptObjId
      If the script to be executed is available in the ELO archive, this member can specify the object ID (or ARCPATH: - see checkoutSord) of the script document. The file is assumed to be encoded in characterset ISO-8859-1, if it does not start with a BOM. If this member is set, the members scriptCode and scriptString should be null.

    • functionName

      protected String functionName
      Call this function in the script code. A function defined in script code that was supplied in a previsious call can be invoked too, as long as this object does not specify scriptCode, scriptString or scriptObjId.

    • functionParams

      protected String[] functionParams
      Function parameters.

  • Constructor Details

    • ExecuteScriptParams

      public ExecuteScriptParams()
      Constructor

    • ExecuteScriptParams

      public ExecuteScriptParams(ExecuteScriptParams rhs)
      Copy constructor
      Parameters:
      rhs - Object to copy from.

  • Method Details

    • getScriptCode

      public FileData getScriptCode()

    • setScriptCode

      public void setScriptCode(FileData scriptCode)

    • getScriptString

      public String getScriptString()

    • setScriptString

      public void setScriptString(String scriptString)

    • getScriptObjId

      public String getScriptObjId()

    • setScriptObjId

      public void setScriptObjId(String scriptObjId)

    • getFunctionName

      public String getFunctionName()

    • setFunctionName

      public void setFunctionName(String functionName)

    • getFunctionParams

      public String[] getFunctionParams()

    • setFunctionParams

      public void setFunctionParams(String[] functionParams)

    • getScriptEngine

      public String getScriptEngine()

    • setScriptEngine

      public void setScriptEngine(String scriptEngine)

    • toString

      public String toString()
      Overrides:
      toString in class Object