|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IGPToolExtensionGen
COM Interface 'IGPToolExtensionGen'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'
Description: 'Provides access to methods on a custom geoprocessing tool extension.' 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 |
IIDea078957_3cb7_41b6_82ba_2f67f4b2f64f
|
static int |
xxDummy
Deprecated. Internal use only |
Method Summary | |
---|---|
boolean |
canEditSource()
Returns whether or not the source for the tool extension can be edited. |
void |
execute(IArray paramvalues,
ITrackCancel trackCancel,
IGPEnvironmentManager pEnvMgr,
IGPMessages messages)
Executes the tool extension given the set of parameter values. |
IGPCustomToolHelper |
getCustomToolHelper()
The custom tool helper object associated with the tool extension. |
IUID |
getDialogCLSID()
The CLSID of a custom dialog class to enter/edit parameter values for custom tools associated with this tool extension. |
IArray |
getParameterInfo()
The parameters required to execute the custom tool associated with this tool extension. |
java.lang.Object |
getRenderer(IGPParameter pParam)
Returns a custom renderer for a given parameter. |
IGPToolExtensionFactoryGen |
getToolExtensionFactory()
The factory object associated with this tool extension. |
boolean |
isLicensed()
Returns whether or not the tool extension has all necessary product licenses to be executed. |
boolean |
isLicensedForProduct()
Returns whether or not the tool extension can be executed within the current application product. |
boolean |
isValid()
Returns whether or not the tool extension is can be executed. |
void |
setCustomToolHelperByRef(IGPCustomToolHelper helper)
The custom tool helper object associated with the tool extension. |
void |
synchronizeMetadata(int action,
int interval,
IPropertySet metadata)
Updates the given metadata property set with the current tool extension properties. |
IGPMessages |
validate(IArray paramvalues,
boolean updateValues,
IGPEnvironmentManager pEnvMgr)
Validates the given set of values. |
Field Detail |
---|
static final int IIDea078957_3cb7_41b6_82ba_2f67f4b2f64f
static final int xxDummy
static final java.lang.String IID
Method Detail |
---|
IGPToolExtensionFactoryGen getToolExtensionFactory() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IGPCustomToolHelper getCustomToolHelper() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setCustomToolHelperByRef(IGPCustomToolHelper helper) throws java.io.IOException, AutomationException
helper
- A reference to a com.esri.arcgis.geoprocessing.IGPCustomToolHelper (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IUID getDialogCLSID() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IArray getParameterInfo() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isValid() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isLicensedForProduct() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isLicensed() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean canEditSource() throws java.io.IOException, AutomationException
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.java.lang.Object getRenderer(IGPParameter pParam) throws java.io.IOException, AutomationException
pParam
- A reference to a com.esri.arcgis.geoprocessing.IGPParameter (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IGPMessages validate(IArray paramvalues, boolean updateValues, IGPEnvironmentManager pEnvMgr) throws java.io.IOException, AutomationException
paramvalues
- A reference to a com.esri.arcgis.system.IArray (in)updateValues
- The updateValues (in)pEnvMgr
- A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void execute(IArray paramvalues, ITrackCancel trackCancel, IGPEnvironmentManager pEnvMgr, IGPMessages messages) throws java.io.IOException, AutomationException
paramvalues
- A reference to a com.esri.arcgis.system.IArray (in)trackCancel
- A reference to a com.esri.arcgis.system.ITrackCancel (in)pEnvMgr
- A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)messages
- A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void synchronizeMetadata(int action, int interval, IPropertySet metadata) throws java.io.IOException, AutomationException
action
- A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in)interval
- The interval (in)metadata
- A reference to a com.esri.arcgis.system.IPropertySet (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |