com.esri.arcgis.addinframework
Class IAddInManagerProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.addinframework.IAddInManagerProxy
All Implemented Interfaces:
IAddInManager, Externalizable, Serializable

public class IAddInManagerProxy
extends com.esri.arcgis.interop.Dispatch
implements IAddInManager, Serializable

IAddInManager Interface

See Also:
Serialized Form

Field Summary
 boolean noncastable
           
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef
 
Constructor Summary
  IAddInManagerProxy()
           
  IAddInManagerProxy(Object obj)
           
protected IAddInManagerProxy(Object obj, String iid)
           
 
Method Summary
 void addFolder(String pathToAddInFolder)
          Adds a path to the folder processing list.
 void addListener(String iidStr, Object theListener, Object theSource)
           
 void createObject(GUID addInID, Object pOuter, 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(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(String[] locale)
          Retrives the current locale.
 IAddInRecord getRecord(GUID addInID)
          Returns the record asociated with the specified ID.
 void initialize(Object pHook, String langID)
          Called to initialize the addin manager (normally called at application startup).
 void initializeEx(Object pHook, 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(String pathToAddInFolder)
          Refreshes AddIns information in the specified folder.
 void removeFolder(String pathToAddInFolder)
          Removes a path from the folder processing list.
 void removeListener(String iidStr, Object theListener)
           
 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(String strID, GUID[] pID)
          Translates an AddIn string ID to it's corresponding registered GUID.
 
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, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

noncastable

public boolean noncastable
Constructor Detail

IAddInManagerProxy

public IAddInManagerProxy()

IAddInManagerProxy

public IAddInManagerProxy(Object obj)
                   throws IOException
Throws:
IOException

IAddInManagerProxy

protected IAddInManagerProxy(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

initialize

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

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

addFolder

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

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

removeFolder

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

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

refresh

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

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

createObject

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

Specified by:
createObject in interface IAddInManager
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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRecord

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

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

getIDsInCategory

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

Specified by:
getIDsInCategory in interface IAddInManager
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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

translateID

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

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

shutdown

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

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

getAddInRecords

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

Specified by:
getAddInRecords in interface IAddInManager
Returns:
A reference to a com.esri.arcgis.addinframework.IEnumNode
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEnabled

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

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

getEnabled

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

Specified by:
getEnabled in interface IAddInManager
Returns:
A com.esri.arcgis.addinframework.esriAddInMode constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAddInFolders

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

Specified by:
getAddInFolders in interface IAddInManager
Returns:
A reference to a com.esri.arcgis.addinframework.IEnumAddInFolders
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAddInRecordsEx

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

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

setUserMode

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

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

isUserMode

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

Specified by:
isUserMode in interface IAddInManager
Returns:
The enabled
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLocale

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

Specified by:
getLocale in interface IAddInManager
Parameters:
locale - The locale (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

initializeEx

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

Specified by:
initializeEx in interface IAddInManager
Parameters:
pHook - A reference to another Object (IUnknown) (in)
langID - The langID (in)
options - A com.esri.arcgis.addinframework.esriAddInSettings constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.