Package org.opencms.rmi

Class CmsShellCommandResult

  • All Implemented Interfaces:
    java.io.Serializable
    public class CmsShellCommandResult
extends java.lang.Object
implements java.io.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:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getErrorCode()
      Gets the error code.
      java.lang.String getOutput()
      Gets the command output.
      java.lang.String getPrompt()
      Gets the prompt.
      boolean hasEcho()
      Returns the echo mode.
      boolean hasError()
      Returns true if an error has occurred.
      boolean isExitCalled()
      Returns true if exit was called.
      void setEcho​(boolean echo)
      Sets the echo mode.
      void setErrorCode​(int errorCode)
      Sets the error code.
      void setExitCalled​(boolean exitCalled)
      Sets the 'exitCalled' flag.
      void setHasError​(boolean hasError)
      Sets the error mode.
      void setOutput​(java.lang.String outputString)
      Sets the command output.
      void setPrompt​(java.lang.String prompt)
      Sets the prompt.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • getErrorCode

        public int getErrorCode()
        Gets the error code.

        Returns:
        the error code

      • getOutput

        public java.lang.String getOutput()
        Gets the command output.

        Returns:
        the command output

      • getPrompt

        public java.lang.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​(java.lang.String outputString)
        Sets the command output.

        Parameters:
        outputString - the command output

      • setPrompt

        public void setPrompt​(java.lang.String prompt)
        Sets the prompt.

        Parameters:
        prompt - the prompt