com.esri.arcgis.datainterop
Class FMEExtensionHelper

java.lang.Object
  extended by com.esri.arcgis.datainterop.FMEExtensionHelper
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IExtension, IExtensionConfig, Serializable

public class FMEExtensionHelper
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IExtension, IExtensionConfig

FMEExtensionHelper Class

Product Availability

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

See Also:
Serialized Form

Constructor Summary
FMEExtensionHelper()
          Constructs a FMEExtensionHelper using ArcGIS Engine.
FMEExtensionHelper(Object obj)
          Construct a FMEExtensionHelper using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 String getDescription()
          Detailed description of the extension.
 String getName()
          The name of the extension.
 String getProductName()
          Name of the extension.
 int getState()
          The state of the extension.
 int hashCode()
          the hashcode for this object
 void setState(int state)
          The state of the extension.
 void shutdown()
          Shuts down the extension.
 void startup(Object initializationData)
          Starts up the extension with the given initialization data.
 
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

FMEExtensionHelper

public FMEExtensionHelper()
                   throws IOException,
                          UnknownHostException
Constructs a FMEExtensionHelper using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

FMEExtensionHelper

public FMEExtensionHelper(Object obj)
                   throws IOException
Construct a FMEExtensionHelper using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to FMEExtensionHelper.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems FMEExtensionHelper theFMEExtensionHelper = (FMEExtensionHelper) 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
The name of the extension.

Remarks

When implementing IExtension to create a custom extension, use the Name property to set the name of this extension.

If you implement persistence (e.g. IPersistVariant) for the extension, the length of the Name property cannot exceed 31 characters.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getName in interface IExtension
Returns:
The extensionName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

startup

public void startup(Object initializationData)
             throws IOException,
                    AutomationException
Starts up the extension with the given initialization data.

Description

initializationData is a reference to the object with which this extension is registered.

Remarks

When implementing IExtension to create a custom extension, use the Startup method to perform some action when the extension gets loaded.

The following list is an example of some of the common object types for the initializationData parameter.

Extension Category initializationData object type
ESRI Mx Application Application (IMxApplication)
ESRI Gx Applcation Application (IGxApplication)
ESRI Editor Extensions Editor (IEditor)

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
startup in interface IExtension
Parameters:
initializationData - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

shutdown

public void shutdown()
              throws IOException,
                     AutomationException
Shuts down the extension.

Remarks

When implementing IExtension to create a custom extension, use the Shutdown method to perform some action when the extension gets unloaded.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
shutdown in interface IExtension
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getProductName

public String getProductName()
                      throws IOException,
                             AutomationException
Name of the extension.

Remarks

ProductName is the name that is displayed for this extension in the Extensions dialog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getProductName in interface IExtensionConfig
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException
Detailed description of the extension.

Remarks

Description is the text that is displayed for this extension in the About this extension box in the Extensions dialog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDescription in interface IExtensionConfig
Returns:
The description
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getState

public int getState()
             throws IOException,
                    AutomationException
The state of the extension.

Remarks

The esriExtensionState enumeration is used with this property to specify whether the extension is enabled, disabled, or unavailable. When the state is enabled, the extension is checked in the Extensions dialog. The checked state of the extension is saved in the user settings in the registry.

If the extension is terminated prematurely (for example, from interrupting a debugging session) the State will be set to 0.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getState in interface IExtensionConfig
Returns:
A com.esri.arcgis.system.esriExtensionState constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setState

public void setState(int state)
              throws IOException,
                     AutomationException
The state of the extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setState in interface IExtensionConfig
Parameters:
state - A com.esri.arcgis.system.esriExtensionState constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.