com.esri.arcgis.schematic
Class NgCommand

java.lang.Object
  com.esri.arcgis.schematic.NgCommand

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, INgCommand, ISupportErrorInfo, Serializable

public class NgCommand
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INgCommand, ISupportErrorInfo

Command object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

Serialized Form

Constructor Summary

NgCommand()
Constructs a NgCommand using ArcGIS Engine.

NgCommand(Object obj)
Construct a NgCommand using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
void	execute() Executes the command.
static String	getClsid() getClsid.
String	getName() Name of the command.
String	getParameter() Parameters for the command.
String	getStatusText() Status bar description for the command.
String	getToolTipText() Description of the command in the button-related tootip.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isChecked() Indicates if the command has been executed.
boolean	isEnabled() Indicates if the command is enabled.
void	setName(String pVal) Name of the command.
void	setParameter(String pVal) Parameters for the command.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

NgCommand

public NgCommand()
          throws IOException,
                 UnknownHostException

Constructs a NgCommand using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

NgCommand

public NgCommand(Object obj)
          throws IOException

Construct a NgCommand using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to NgCommand.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems NgCommand theNgCommand = (NgCommand) obj;

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the command.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getName in interface INgCommand

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String pVal)
             throws IOException,
                    AutomationException

Name of the command.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setName in interface INgCommand

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameter

public String getParameter()
                    throws IOException,
                           AutomationException

Parameters for the command.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getParameter in interface INgCommand

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParameter

public void setParameter(String pVal)
                  throws IOException,
                         AutomationException

Parameters for the command.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

setParameter in interface INgCommand

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStatusText

public String getStatusText()
                     throws IOException,
                            AutomationException

Status bar description for the command.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getStatusText in interface INgCommand

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToolTipText

public String getToolTipText()
                      throws IOException,
                             AutomationException

Description of the command in the button-related tootip.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

getToolTipText in interface INgCommand

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

execute

public void execute()
             throws IOException,
                    AutomationException

Executes the command.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

execute in interface INgCommand

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isChecked

public boolean isChecked()
                  throws IOException,
                         AutomationException

Indicates if the command has been executed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isChecked in interface INgCommand

Returns:

The ret

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

INgBehavior

isEnabled

public boolean isEnabled()
                  throws IOException,
                         AutomationException

Indicates if the command is enabled.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:

isEnabled in interface INgCommand

Returns:

The ret

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.