com.esri.arcgis.geodatabase
Class DddServerEnvironment

java.lang.Object
  com.esri.arcgis.geodatabase.DddServerEnvironment

All Implemented Interfaces:

IExtension, IExtensionConfig, ISupportErrorInfo, java.io.Serializable

public class DddServerEnvironment

extends java.lang.Object

implements IExtension, IExtensionConfig, ISupportErrorInfo

3D Server Environment (license) singleton object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

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

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
IExtension	getAsIExtension() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
IExtensionConfig	getAsIExtensionConfig() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
ISupportErrorInfo	getAsISupportErrorInfo() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
java.lang.String	getDescription() Detailed description of the extension.
java.lang.String	getName() The name of the extension.
java.lang.String	getProductName() Name of the extension.
int	getState() The state of the extension.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) Supported Platforms
void	setState(int state) The state of the extension.
void	shutdown() Shuts down the extension.
void	startup(java.lang.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

Constructor Detail

DddServerEnvironment

public DddServerEnvironment(java.lang.Object obj)
                     throws java.io.IOException

Construct a DddServerEnvironment using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to DddServerEnvironment.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
DddServerEnvironment o = (DddServerEnvironment)obj; // will not work

DddServerEnvironment o = new DddServerEnvironment(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server DddServerEnvironment theDddServerEnvironment = (DddServerEnvironment) obj;

Throws:

java.io.IOException - if there are interop problems

Method Detail

getAsIExtension

public IExtension getAsIExtension()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIExtensionConfig

public IExtensionConfig getAsIExtensionConfig()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsISupportErrorInfo

public ISupportErrorInfo getAsISupportErrorInfo()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IExtension

The name of the extension.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

getName in interface IExtension

Returns:

The extensionName

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

startup

public void startup(java.lang.Object initializationData)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IExtension

Starts up the extension with the given initialization data.

Supported Platforms

Windows, Solaris, Linux

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)

Specified by:

startup in interface IExtension

Parameters:

initializationData - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

shutdown

public void shutdown()
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IExtension

Shuts down the extension.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:

shutdown in interface IExtension

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getProductName

public java.lang.String getProductName()
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IExtensionConfig

Name of the extension.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:

getProductName in interface IExtensionConfig

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IExtensionConfig

Detailed description of the extension.

Supported Platforms

Windows, Solaris, Linux

Remarks

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

Specified by:

getDescription in interface IExtensionConfig

Returns:

The description

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getState

public int getState()
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IExtensionConfig

The state of the extension.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

getState in interface IExtensionConfig

Returns:

A com.esri.arcgis.system.esriExtensionState constant

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setState

public void setState(int state)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IExtensionConfig

The state of the extension.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setState in interface IExtensionConfig

Parameters:

state - A com.esri.arcgis.system.esriExtensionState constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: ISupportErrorInfo

Supported Platforms

Windows, Solaris, Linux

Description

Indicates whether the interface supports IErrorInfo.

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.