com.ibm.ftt.resources.core.physical
Interface IRemoteCommand


public interface IRemoteCommand

The IRemoteCommand interface can be used to execute a command on a remote system.

An IRemoteCommand can be created using IOSImage.getCommandObject().


Field Summary
static String COPY_RIGHT
           
 
Method Summary
 String getCommandString()
          Gets the command string that is associated with this command object.
 String getMessageString()
          Returns the message string from the server if an exception occurred during command execution.
 String getResults()
          Returns the results of the execution of the command.
 IOSImage getSystemImage()
          Gets the system image associated with this remote command object.
 boolean isSuccess()
          Determines if the command execution succeeded.
 void run()
          Runs the command on the remote system.
 void setCommandString(String command)
          Sets the command string to be executed.
 

Field Detail

COPY_RIGHT

static final String COPY_RIGHT
See Also:
Constant Field Values
Method Detail

getSystemImage

IOSImage getSystemImage()
Gets the system image associated with this remote command object.

Returns:
the target system image where this remote command is to be executed
See Also:
setSystemImage(IOSImage)

setCommandString

void setCommandString(String command)
Sets the command string to be executed.

Parameters:
command - the command string

getCommandString

String getCommandString()
Gets the command string that is associated with this command object.

Returns:
the command string that is associated with this command object

run

void run()
         throws OperationFailedException
Runs the command on the remote system.

Throws:
OperationFailedException - if the command execution fails; this could be because the system is not connected, or the command execution failed on the remote system

isSuccess

boolean isSuccess()
Determines if the command execution succeeded.

Returns:
true if command succeeded; false otherwise

getResults

String getResults()
Returns the results of the execution of the command.

Returns:
the results from the command execution

getMessageString

String getMessageString()
Returns the message string from the server if an exception occurred during command execution.

Returns:
the message string associated with the exception