Package com.uc4.api.objects

Class BackendVariable

java.lang.Object
com.uc4.api.objects.BackendVariable
public class BackendVariable extends Object
Backend Variable.

  • Constructor Details

    • BackendVariable

      protected BackendVariable(com.uc4.util.XMLDocument doc)

  • Method Details

    • store

      protected void store(com.uc4.util.XMLDocument doc, Element parent)

    • getHost

      public UC4HostName getHost()
      Returns the name of the Host. If the host is not set the return value is an empty UC4HostName instance.
      Returns:
      Name of the host, never null

    • setHost

      public void setHost(UC4HostName host)
      Sets the Name of the host for the file list. If null is passed the field Host will not be set.
      Parameters:
      host - Name of the host

    • getLogin

      public UC4ObjectName getLogin()
      Returns the name of the LOGIN object. If the login is not set the return value is an empty UC4ObjectName instance.
      Returns:
      Name of the Login object, never null

    • setLogin

      public void setLogin(UC4ObjectName login)
      Sets the name of the LOGIN object. If null is passed the field will not be set.
      Parameters:
      login - Name of the LOGIN object

    • isApplyUserHost

      public boolean isApplyUserHost()
      Returns true if the host name from the user settings should be applied.
      Returns:
      True if the host should be used which set in the settings of the logged on user.

    • setApplyUserHost

      public void setApplyUserHost(boolean applyUserHost)
      Sets or clears the check box "Apply User's Host" in the User interface.
      Parameters:
      applyUserHost - if true the host name from the user settings will be used.

    • isApplyUserLogin

      public boolean isApplyUserLogin()
      Returns true if the LOGIN object from the settings of the currently logged on user should be used.
      Returns:
      true if the LOGIN object

    • setApplyUserLogin

      public void setApplyUserLogin(boolean applyUserLogin)
      Sets or clears the check box "Apply User's Login" in the User interface.
      Parameters:
      applyUserLogin - if true the login name from the user settings will be used.

    • getResultFormat

      public String getResultFormat()
      Returns the result format.
      Returns:
      Result format.

    • setResultFormat

      public void setResultFormat(String resultFormat)
      Sets the result format. The maximum length is 1024 characters.
      Parameters:
      resultFormat - String which contains the result format.

    • windowsCommandsSize

      public int windowsCommandsSize()
      Returns the number of Windows Commands entries.
      Returns:
      Number of Windows Commands entries.

    • unixCommandsSize

      public int unixCommandsSize()
      Returns the number of Unix Commands entries.
      Returns:
      Number of Unix Commands entries.

    • windowsCommandsIterator

      public Iterator<BackendCommand> windowsCommandsIterator()
      Returns an iterator over Windows BackendCommand.
      Returns:
      Iterator over Windows Commands.

    • unixCommandsIterator

      public Iterator<BackendCommand> unixCommandsIterator()
      Returns an iterator over Unix BackendCommand.
      Returns:
      Iterator over Unix Commands.

    • addWindowsCommand

      public void addWindowsCommand(BackendCommand winCommand)
      Adds a new BackendCommand to the Windows commands.
      Parameters:
      winCommand - BackendCommand with contains the Windows command for the backend variable.

    • addUnixCommand

      public void addUnixCommand(BackendCommand unixCommand)
      Adds a new BackendCommand to the Unix commands.
      Parameters:
      unixCommand - BackendCommand with contains the Windows command for the backend variable.