com.esri.arcgis.datasourcesfile
Class LicensedDataExtension

java.lang.Object
  extended by com.esri.arcgis.datasourcesfile.LicensedDataExtension
All Implemented Interfaces:
IDataLicenseManager, com.esri.arcgis.interop.RemoteObjRef, IAutoExtension, IExtension, Serializable

public class LicensedDataExtension
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAutoExtension, IExtension, IDataLicenseManager

The Licensed Data Extension.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
LicensedDataExtension()
          Constructs a LicensedDataExtension using ArcGIS Engine.
LicensedDataExtension(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LicensedDataExtension theLicensedDataExtension = (LicensedDataExtension) obj;
 
Method Summary
 void addLicenseFromFile(String bstrLicenseFileName)
          Adds license information.
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 int getCount()
          Number of license information.
 IDataLicenseInfo getLicenseInfo(int nIdx)
          Returns license information by index.
 IDataLicenseInfo getLicenseInfoFromFile(String bstrLicenseFileName)
          Returns license information by file name.
 String getName()
          The name of the extension.
 int hashCode()
          the hashcode for this object
 void removeLicense(int nIdx)
          Removes license information.
 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

LicensedDataExtension

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

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

LicensedDataExtension

public LicensedDataExtension(Object obj)
                      throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
LicensedDataExtension theLicensedDataExtension = (LicensedDataExtension) obj;

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

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
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.

getCount

public int getCount()
             throws IOException,
                    AutomationException
Number of license information.

Product Availability

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

Specified by:
getCount in interface IDataLicenseManager
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLicenseInfo

public IDataLicenseInfo getLicenseInfo(int nIdx)
                                throws IOException,
                                       AutomationException
Returns license information by index.

Product Availability

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

Specified by:
getLicenseInfo in interface IDataLicenseManager
Parameters:
nIdx - The nIdx (in)
Returns:
A reference to a com.esri.arcgis.datasourcesfile.IDataLicenseInfo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addLicenseFromFile

public void addLicenseFromFile(String bstrLicenseFileName)
                        throws IOException,
                               AutomationException
Adds license information.

Product Availability

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

Specified by:
addLicenseFromFile in interface IDataLicenseManager
Parameters:
bstrLicenseFileName - The bstrLicenseFileName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeLicense

public void removeLicense(int nIdx)
                   throws IOException,
                          AutomationException
Removes license information.

Product Availability

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

Specified by:
removeLicense in interface IDataLicenseManager
Parameters:
nIdx - The nIdx (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLicenseInfoFromFile

public IDataLicenseInfo getLicenseInfoFromFile(String bstrLicenseFileName)
                                        throws IOException,
                                               AutomationException
Returns license information by file name.

Product Availability

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

Specified by:
getLicenseInfoFromFile in interface IDataLicenseManager
Parameters:
bstrLicenseFileName - The bstrLicenseFileName (in)
Returns:
A reference to a com.esri.arcgis.datasourcesfile.IDataLicenseInfo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.