org.eclipse.rse.subsystems.shells.core.subsystems
Interface ICandidateCommand

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.

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.

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