com.esri.arcgis.system
Interface IJITExtensionManager

All Superinterfaces:
Serializable
All Known Implementing Classes:
ExtensionManager

public interface IJITExtensionManager
extends Serializable

Provides access to the Just In Time Extension Manager.

Description

The IJITExtensionManager interface provides properties and methods for inserting, removing and managing JIT (just-in-time) extensions. JIT extensions are like standard extensions, however they are not started up at application startup, but only when they are required.

IJITExtensionManager is not normally called by client code.

See the About Extensions topics for more details on just-in-time extensions.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 IUID getJITExtensionCLSID(int index)
          Retrieves the CLSID of the JIT Extension at index.
 int getJITExtensionCount()
          The number of just in time extensions registered with the application.
 void insertExtension(IUID pExtCLSID, IExtension pExtension)
          Adds an extension to the manager without initialization.
 boolean isExtensionEnabled(IUID pExtCLSID)
          Returns whether the extension is currently checked on.
 boolean isLoaded(IUID pID)
          Returns whether the extension is currently loaded.
 void removeExtension(IExtension pExtension)
          Removes a just in time extension from the manager.
 

Method Detail

getJITExtensionCount

int getJITExtensionCount()
                         throws IOException,
                                AutomationException
The number of just in time extensions registered with the application.

Description

Returns the number of JIT extensions currently in the application. This does not include any ordinary extensions.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getJITExtensionCLSID

IUID getJITExtensionCLSID(int index)
                          throws IOException,
                                 AutomationException
Retrieves the CLSID of the JIT Extension at index.

Product Availability

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

Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isLoaded

boolean isLoaded(IUID pID)
                 throws IOException,
                        AutomationException
Returns whether the extension is currently loaded.

Description

Indicates whether the specified JIT extension is loaded. A JIT extension will be loaded the first time that IApplication::FindExtensionByCLSID is called for that extension. Use the JITExtensionCLSID property to get the UID of the extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pID - A reference to a com.esri.arcgis.system.IUID (in)
Returns:
The bLoaded
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeExtension

void removeExtension(IExtension pExtension)
                     throws IOException,
                            AutomationException
Removes a just in time extension from the manager.

Description

Removed the specified JIT extension from the ExtensionManager.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pExtension - A reference to a com.esri.arcgis.system.IExtension (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insertExtension

void insertExtension(IUID pExtCLSID,
                     IExtension pExtension)
                     throws IOException,
                            AutomationException
Adds an extension to the manager without initialization.

Description

Adds the specified JIT extension to the ExtensionManager. Note that a JIT extension will be loaded the first time that IApplication::FindExtensionByCLSID is called for that extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pExtCLSID - A reference to a com.esri.arcgis.system.IUID (in)
pExtension - A reference to a com.esri.arcgis.system.IExtension (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isExtensionEnabled

boolean isExtensionEnabled(IUID pExtCLSID)
                           throws IOException,
                                  AutomationException
Returns whether the extension is currently checked on.

Description

Indicates whether the specified JIT extension is enabled. Use the JITExtensionCLSID property to get the UID of the extension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
pExtCLSID - A reference to a com.esri.arcgis.system.IUID (in)
Returns:
The enabled
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.