Remote Systems
v6.4.1

com.ibm.etools.systems.subsystems
Interface ICandidateCommand

All Known Implementing Classes:
CandidateCommandImpl, LocalCandidateCommand

public interface ICandidateCommand

This interface represents a candidate command. A candidate command is a command that can be run in a command subsystem. The command subsystem api, getCandidateCommands(), returns a list of candidate commands. The primary use of candidate commands is for command line content assist. Implement this interface to provide unique command candidates for a particular command subsystem.


Field Summary
static String Copyright
           
 
Method Summary
 String getDescription()
          Gets the description for a candidate command.
 ImageDescriptor getImageDescriptor()
          Gets the image descriptor to display for a candidate command
 String getName()
          Gets the name of the candidate command
 String getPath()
          Gets the path for a candidate command
 String getType()
          Gets the type of the candidate command.
 

Field Detail

Copyright

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

getName

public String getName()
Gets the name of the candidate command

Returns:
the name of the candidate command

getType

public String getType()
Gets the type of the candidate command.

Returns:
the type of the command

getDescription

public String getDescription()
Gets the description for a candidate command.

Returns:
the description of the command

getImageDescriptor

public ImageDescriptor getImageDescriptor()
Gets the image descriptor to display for a candidate command

Returns:
the image descriptor for the command

getPath

public String getPath()
Gets the path for a candidate command

Returns:
the path of the command if one exists

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.