Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.addinframework
Interface IAddInManager

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
IAddInManagerProxy
public interface IAddInManager
extends java.io.Serializable

COM Interface 'IAddInManager'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\SharedArcGIS\DepFiles\com\DADF\esriDADFSystem.tlb'

Description: 'IAddInManager Interface' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID21578701_16a1_435c_b839_3ea53cb354f5
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void addFolder(java.lang.String pathToAddInFolder)
          Adds a path to the folder processing list.
 void createObject(GUID addInID, java.lang.Object pOuter, java.lang.Object[] ppObj)
          Create an instance of the specified object.
 IEnumAddInFolders getAddInFolders()
          Retrieves add-in probing folders.
 IEnumNode getAddInRecords()
          Retrieves all registered addin records.
 IEnumNode getAddInRecordsEx(java.lang.String xpathQuery)
          Retrieves registered addin records matching the specified xpath query.
 int getEnabled()
          Indicates if the addin manager is enabled.
 void getIDsInCategory(GUID category, IEnumAddInID[] ppEnumAddInIDs)
          Enumerate objects IDs within a specified category.
 void getLocale(java.lang.String[] locale)
          Retrives the current locale.
 IAddInRecord getRecord(GUID addInID)
          Returns the record asociated with the specified ID.
 void initialize(java.lang.Object pHook, java.lang.String langID)
          Called to initialize the addin manager (normally called at application startup).
 void initializeEx(java.lang.Object pHook, java.lang.String langID, int options)
          Called to initialize the addin manager (normally called at application startup).
 boolean isUserMode()
          Indicates if the add-in manager is in user mode.
 void refresh(java.lang.String pathToAddInFolder)
          Refreshes AddIns information in the specified folder.
 void removeFolder(java.lang.String pathToAddInFolder)
          Removes a path from the folder processing list.
 void setEnabled(int enabled)
          Indicates if the add-in manager is enabled.
 void setUserMode(boolean enabled)
          Indicates if the add-in manager is in user mode.
 void shutdown()
          Called to shutdown the addin manager (normally called at application shutdown).
 void translateID(java.lang.String strID, GUID[] pID)
          Translates an AddIn string ID to it's corresponding registered GUID.
 

Field Detail

IID21578701_16a1_435c_b839_3ea53cb354f5

static final int IID21578701_16a1_435c_b839_3ea53cb354f5
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

initialize

void initialize(java.lang.Object pHook,
                java.lang.String langID)
                throws java.io.IOException,
                       AutomationException
Called to initialize the addin manager (normally called at application startup).

Parameters:
pHook - A reference to another Object (IUnknown) (in)
langID - The langID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addFolder

void addFolder(java.lang.String pathToAddInFolder)
               throws java.io.IOException,
                      AutomationException
Adds a path to the folder processing list.

Parameters:
pathToAddInFolder - The pathToAddInFolder (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeFolder

void removeFolder(java.lang.String pathToAddInFolder)
                  throws java.io.IOException,
                         AutomationException
Removes a path from the folder processing list.

Parameters:
pathToAddInFolder - The pathToAddInFolder (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refresh

void refresh(java.lang.String pathToAddInFolder)
             throws java.io.IOException,
                    AutomationException
Refreshes AddIns information in the specified folder.

Parameters:
pathToAddInFolder - The pathToAddInFolder (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createObject

void createObject(GUID addInID,
                  java.lang.Object pOuter,
                  java.lang.Object[] ppObj)
                  throws java.io.IOException,
                         AutomationException
Create an instance of the specified object.

Parameters:
addInID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
pOuter - A reference to another Object (IUnknown) (in)
ppObj - A reference to another Object (IUnknown) (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRecord

IAddInRecord getRecord(GUID addInID)
                       throws java.io.IOException,
                              AutomationException
Returns the record asociated with the specified ID.

Parameters:
addInID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Returns:
A reference to a com.esri.arcgis.addinframework.IAddInRecord
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIDsInCategory

void getIDsInCategory(GUID category,
                      IEnumAddInID[] ppEnumAddInIDs)
                      throws java.io.IOException,
                             AutomationException
Enumerate objects IDs within a specified category.

Parameters:
category - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
ppEnumAddInIDs - A reference to a com.esri.arcgis.addinframework.IEnumAddInID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

translateID

void translateID(java.lang.String strID,
                 GUID[] pID)
                 throws java.io.IOException,
                        AutomationException
Translates an AddIn string ID to it's corresponding registered GUID.

Parameters:
strID - The strID (in)
pID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

shutdown

void shutdown()
              throws java.io.IOException,
                     AutomationException
Called to shutdown the addin manager (normally called at application shutdown).

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAddInRecords

IEnumNode getAddInRecords()
                          throws java.io.IOException,
                                 AutomationException
Retrieves all registered addin records.

Returns:
A reference to a com.esri.arcgis.addinframework.IEnumNode
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEnabled

void setEnabled(int enabled)
                throws java.io.IOException,
                       AutomationException
Indicates if the add-in manager is enabled.

Parameters:
enabled - A com.esri.arcgis.addinframework.esriAddInMode constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEnabled

int getEnabled()
               throws java.io.IOException,
                      AutomationException
Indicates if the addin manager is enabled.

Returns:
A com.esri.arcgis.addinframework.esriAddInMode constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAddInFolders

IEnumAddInFolders getAddInFolders()
                                  throws java.io.IOException,
                                         AutomationException
Retrieves add-in probing folders.

Returns:
A reference to a com.esri.arcgis.addinframework.IEnumAddInFolders
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAddInRecordsEx

IEnumNode getAddInRecordsEx(java.lang.String xpathQuery)
                            throws java.io.IOException,
                                   AutomationException
Retrieves registered addin records matching the specified xpath query.

Parameters:
xpathQuery - The xpathQuery (in)
Returns:
A reference to a com.esri.arcgis.addinframework.IEnumNode
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUserMode

void setUserMode(boolean enabled)
                 throws java.io.IOException,
                        AutomationException
Indicates if the add-in manager is in user mode.

Parameters:
enabled - The enabled (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUserMode

boolean isUserMode()
                   throws java.io.IOException,
                          AutomationException
Indicates if the add-in manager is in user mode.

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

getLocale

void getLocale(java.lang.String[] locale)
               throws java.io.IOException,
                      AutomationException
Retrives the current locale.

Parameters:
locale - The locale (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

initializeEx

void initializeEx(java.lang.Object pHook,
                  java.lang.String langID,
                  int options)
                  throws java.io.IOException,
                         AutomationException
Called to initialize the addin manager (normally called at application startup).

Parameters:
pHook - A reference to another Object (IUnknown) (in)
langID - The langID (in)
options - A com.esri.arcgis.addinframework.esriAddInSettings constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD