com.esri.arcgis.geodatabase
Class IPlugInLicenseProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.geodatabase.IPlugInLicenseProxy
All Implemented Interfaces:
IPlugInLicense, Externalizable, Serializable

public class IPlugInLicenseProxy
extends com.esri.arcgis.interop.Dispatch
implements IPlugInLicense, Serializable

Provides access to members for managing a licensed plug-in.

Description

Implement this interface if your plug-in data source requires a license to be used. The interface can be implemented on the plug-in workspace helper class, or the plug-in dataset helper.

A plug-in workspace helper should implement IPlugInLicense if enabling the license enables all datasets of the data source type. If only some datasets are to be enabled, the interface should be implemented on the plug-in dataset helper. If the interface is implemented on both classes, the implementation on the dataset helper will be used. The license is checked by the plug-in feature classes, tables and cursors when they are created.

Remarks

If your plug-in data source will require a license to be used, you must implement a plug-in extension class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IPlugInLicenseProxy()
           
  IPlugInLicenseProxy(Object obj)
           
protected IPlugInLicenseProxy(Object obj, String iid)
           
 
Method Summary
 void addLicenseRef()
          Increases the count of things needing the license.
 void addListener(String iidStr, Object theListener, Object theSource)
           
 void checkExtensionLicense()
          Checks if the license for the extension is enabled.
 void readExternal(ObjectInput in)
           
 void releaseLicenseRef()
          Decreases the count of things needing the license.
 void removeListener(String iidStr, Object theListener)
           
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IPlugInLicenseProxy

public IPlugInLicenseProxy()

IPlugInLicenseProxy

public IPlugInLicenseProxy(Object obj)
                    throws IOException
Throws:
IOException

IPlugInLicenseProxy

protected IPlugInLicenseProxy(Object obj,
                              String iid)
                       throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

checkExtensionLicense

public void checkExtensionLicense()
                           throws IOException,
                                  AutomationException
Checks if the license for the extension is enabled. Fails if not enabled.

Description

Succeeds if the license is enabled. May attempt to enable the license if the extension is an automatic extension. If the license is not or cannot be enabled, this method should fail. If possible, it should fail with FDO_E_NO_OPERATION_LICENSE as the HRESULT.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

addLicenseRef

public void addLicenseRef()
                   throws IOException,
                          AutomationException
Increases the count of things needing the license.

Description

Increments the count of datasets and cursors using the license.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

releaseLicenseRef

public void releaseLicenseRef()
                       throws IOException,
                              AutomationException
Decreases the count of things needing the license.

Description

Decrements the count of datasets and cursors using the license.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException