Package org.opencms.rmi

Class CmsShellCommandResult

java.lang.Object
org.opencms.rmi.CmsShellCommandResult
All Implemented Interfaces:
Serializable
public class CmsShellCommandResult extends Object implements Serializable
An object containing the output of a remote shell command and also the updated values for some of the internal state fields of the client application.

See Also:

  • Constructor Details

  • Method Details

    • getErrorCode

      public int getErrorCode()
      Gets the error code.

      Returns:
      the error code

    • getOutput

      public String getOutput()
      Gets the command output.

      Returns:
      the command output

    • getPrompt

      public String getPrompt()
      Gets the prompt.

      Returns:
      the prompt

    • hasEcho

      public boolean hasEcho()
      Returns the echo mode.

      Returns:
      the echo mode

    • hasError

      public boolean hasError()
      Returns true if an error has occurred.

      Returns:
      true if an error has occurred

    • isExitCalled

      public boolean isExitCalled()
      Returns true if exit was called.

      Returns:
      true if exit was called

    • setEcho

      public void setEcho(boolean echo)
      Sets the echo mode.

      Parameters:
      echo - the echo mode

    • setErrorCode

      public void setErrorCode(int errorCode)
      Sets the error code.

      Parameters:
      errorCode - the error code

    • setExitCalled

      public void setExitCalled(boolean exitCalled)
      Sets the 'exitCalled' flag.

      Parameters:
      exitCalled - the new value

    • setHasError

      public void setHasError(boolean hasError)
      Sets the error mode.

      Parameters:
      hasError - the error mode

    • setOutput

      public void setOutput(String outputString)
      Sets the command output.

      Parameters:
      outputString - the command output

    • setPrompt

      public void setPrompt(String prompt)
      Sets the prompt.

      Parameters:
      prompt - the prompt