Remote Systems
v6.4.1

com.ibm.etools.systems.subsystems
Interface IRemoteCommandShell

All Known Implementing Classes:
RemoteCommandShellImpl

public interface IRemoteCommandShell

This interface represents a handle to a remote command, which is either a transient command or a command shell.


Field Summary
static String Copyright
           
 
Method Summary
 void addOutput(Object output)
          Add an output object to the list of output for this command
 void associateProject(IProject project)
           
 IProject getAssociatedProject()
           
 ICandidateCommand[] getCandidateCommands()
          Return the list of possible commands for this command shell
 RemoteCmdSubSystem getCommandSubSystem()
          Return the command subsystem associated with this command
 Object getContext()
          Get the current context for this command shell.
 RemoteFileSubSystem getFileSubSystem()
          Return the file subsystem associated with this command
 String[] getHistory()
          Return the list of commands passed into this command
 String getId()
          Gets the ID of the command shell
 int getIndexOf(Object output)
          Get the position of this output object in the command container
 String getName()
          Gets the name of the command shell or command that is being run.
 Object getOutputAt(int index)
          Get the output object the specified index
 int getSize()
          Return the number of output objects for this command.
 String getType()
          Gets the type of the command shell or command that is being run.
 boolean isActive()
          Indicate whether the corresponding command is running or not
 Object[] listOutput()
          Get the list of output objects for this command.
 void removeOutput()
          Remove output from the list of output for this command
 void removeOutput(Object output)
          Remove output from the list of output for this command
 

Field Detail

Copyright

public static final String Copyright
See Also:
Constant Field Values
Method Detail

getId

public String getId()
Gets the ID of the command shell

Returns:
the id

getName

public String getName()
Gets the name of the command shell or command that is being run.

Returns:
the name of the command

getType

public String getType()
Gets the type of the command shell or command that is being run. The type may either be a "Shell" or a "Command".

Returns:
the type of the command

listOutput

public Object[] listOutput()
Get the list of output objects for this command.

Returns:
the list of output objects

getContext

public Object getContext()
Get the current context for this command shell. In the case of a unix shell, this will be the working directory

Returns:
the current context

getSize

public int getSize()
Return the number of output objects for this command.

Returns:
the number of output objects

getFileSubSystem

public RemoteFileSubSystem getFileSubSystem()
Return the file subsystem associated with this command

Returns:
the file subsystem associated with this command

getCommandSubSystem

public RemoteCmdSubSystem getCommandSubSystem()
Return the command subsystem associated with this command

Returns:
the command subsystem associated with this command

associateProject

public void associateProject(IProject project)

getAssociatedProject

public IProject getAssociatedProject()

addOutput

public void addOutput(Object output)
Add an output object to the list of output for this command

Parameters:
output - the output object to add

removeOutput

public void removeOutput()
Remove output from the list of output for this command


removeOutput

public void removeOutput(Object output)
Remove output from the list of output for this command


getIndexOf

public int getIndexOf(Object output)
Get the position of this output object in the command container


getOutputAt

public Object getOutputAt(int index)
Get the output object the specified index


isActive

public boolean isActive()
Indicate whether the corresponding command is running or not

Returns:
whether the command is running or not

getHistory

public String[] getHistory()
Return the list of commands passed into this command

Returns:
the list of commands issued

getCandidateCommands

public ICandidateCommand[] getCandidateCommands()
Return the list of possible commands for this command shell

Returns:
the list of possible commands

Remote Systems
v6.4.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.