com.esri.arcgis.geoprocessing
Class GPUtilities

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.GPUtilities
All Implemented Interfaces:
IGPMessageManager, IGPUtilities, IGPUtilities2, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class GPUtilities
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPUtilities, IGPUtilities2, IGPMessageManager

Helper object with common geoprocessing utility methods.

Remarks

The GPUtilities object is mainly intended for developers building custom tools. For more information about building custom tools, refer to the technical document Building Geoprocessing Function Tools.

Product Availability

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

Supported Platforms

Windows

Singleton:

This type is a singleton.

See Also:
Serialized Form

Constructor Summary
GPUtilities()
          Constructs a GPUtilities using ArcGIS Engine.
GPUtilities(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPUtilities theGPUtilities = (GPUtilities) obj;
 
Method Summary
 void abortEditOperation(IWorkspaceEdit pWorkspace)
          Abort edit operation within the application.
 void addInternalLayer(ILayer pLayer)
          Adds a layer object to the geoprocessing utility object.
 void addInternalLayer2(ILayer pLayer, IGPLayer pGPLayer)
          Adds a layer object and geoprocessing layer object to the geoprocessing utility object.
 void addInternalTable(ITable pTable)
          Adds the given table to the utility object's list of tables.
 void addInternalTable2(ITable pTable, IGPTableView pGPTableView)
          Adds the given table to the utility object's list of tables.
 void addMessage(int type, int iD, IGPMessages msgs)
          Add a given message from the message id to the messages object.
 void addMessage1Args(int type, int iD, String arg1, IGPMessages msgs)
          Add a given message from the message id to the messages object.
 void addMessage2Args(int type, int iD, String arg1, String arg2, IGPMessages msgs)
          Add a given message from the message id to the messages object.
 void addMessageText(int type, int iD, String msg, IGPMessages msgs)
          Add a given message from the message text to the messages object.
 void addToMap(IGPValue pGPValue, String name, boolean temporary, Object pUnkRenderer)
          Adds the given geoprocessing value object to the application display.
 void addToMapEx(IGPValue pGPValue, String name, boolean temporary, Object pUnkRenderer, boolean visible)
          Adds the given geoprocessing value object to the application display.
 boolean canAddToMap()
          Returns whether datasets can be added to the current application display.
 void chainMessage(int type, int iD)
          Chain a given message from the message id.
 void chainMessage1Args(int type, int iD, String arg1)
          Chain a given message from the message id.
 void chainMessage2Args(int type, int iD, String arg1, String arg2)
          Chain a given message from the message id.
 void chainMessageText(int type, int iD, String msg)
          Chain a given message from the message text.
 void checkForErrors(long fdoError, IGPMessages messages, boolean keepAllErrors)
          Check for any errors in the IErrorInfo structure.
 void cleanupEditSession(boolean abort)
          Cleans up any edit session.
 void clearInMemoryWorkspace()
          Clear the virtual workspace.
 boolean compareWildCard(String wildCard, String data)
          Returns whether the given string satisfies the given wildcard string.
 void copy(IGPValue pSourceGPValue, IGPValue pTargetGPValue)
          Copies the object referred to by the given geoprocessing value object.
 IDataElement createDataElement(String catalogPath, IGPDataType pDataType, String optionalWorkspace)
          Creates a new data element object from the catalog object specified by the given path, data type, and optional workspace.
 IName createFeatureClassName(String catalogPath)
          Creates a feature class name object from the given catalog path.
 IGPValue createFeatureLayer(String catalogPath)
          Creates a geoprocessing feature layer object from the catalog path.
 IGPValue createParameterValue(String text, IGPDataType pDataType, int direction)
          Creates a geoprocessing value object of the given data type from the given string.
 IName createParentFromCatalogPath(String catalogPath)
          Returns a name object corresponding to the parent object of the specified catalog path.
 IName createRasterCatalogName(String catalogPath)
          Creates a raster catalog name object from the given catalog path.
 IName createRasterDatasetName(String catalogPath)
          Creates a raster dataset name object from the given catalog path.
 IName createTableName(String catalogPath)
          Creates a table name object from the given catalog path.
 void createToolboxFromFactory(String alias, String location, String toolboxName)
          Creates a toolbox at the given location for a function factory of a given alias.
 IDETable decodeDETable(IGPValue pValue)
          Returns the table data element specified by the given geoprocessing value object.
 void decodeFeatureLayer(IGPValue pValue, IFeatureClass[] ppFC, IQueryFilter[] ppQF)
          Returns the feature class and query filter specified by the given geoprocessing value object.
 ILayer decodeLayer(IGPValue pValue)
          Returns the layer object specified by the given geoprocessing value object.
 IRaster decodeRaster(IGPValue pValue)
          Returns the raster specified by the given geoprocessing value object.
 void decodeRasterLayer(IGPValue pValue, IRasterDataset[] ppRD)
          Returns the raster dataset specified by the given geoprocessing value object.
 IStandaloneTable decodeStandaloneTable(IGPValue pValue)
          Returns the standalone table object specified by the given geoprocessing value object.
 void decodeTableView(IGPValue pValue, ITable[] ppTable, IQueryFilter[] ppQF)
          Returns the table and query filter specified by the given geoprocessing value object.
 void delete(IGPValue pGPValue)
          Deletes the object referred to by the given geoprocessing value object.
 boolean equals(Object o)
          Compare this object with another
 boolean exists(IGPValue pGPValue)
          Returns whether the object referred to by the given geoprocessing value object exists.
 void expandDataElement(IDataElement pInDE, IDEBrowseOptions pExpandOptions)
          Expands the properties of the given data element according to the given expand options.
 void exportFeatureClass(IDataElement pSourceDataElement, IDataElement pTargetDataElement)
          Exports the given feature class to a new feature class.
 boolean fieldExists(IGPValue pGPValue, IField pField)
          Returns whether the given field exists within the given geoprocessing value object.
 IField findField(IGPValue pGPValue, String name)
          Returns the field object with the specified name in the given geoprocessing value object.
 ILayer findMapLayer(String name)
          Returns a layer with the given name.
 IGPLayer findMapLayer2(String name, ILayer[] ppLayer)
          Returns a layer and geoprocessing layer with the given name.
 ITable findMapTable(String name)
          Locates a table with the specified name.
 IGPTableView findMapTable2(String name, ITable[] ppTable)
          Locates a table with the specified name and returns the table and geoprocessing table view objects.
 IGPValue generateDefaultOutputValue(IGPEnvironmentManager pEnvMgr, String functionname, IGPParameter pOutputParam, IGPValue pInputValue, String extension, int outputFileBaseLimit)
          Generates the default output value and sets its path to an unique name.
 void generateGeographicTransformDomain(Object iUnk, IGPCodedValueDomain pGTDomain, ISpatialReference pInSR, ISpatialReference pOutSR, IGPMessages pMessages)
          Generate the matching geographic transform domain from an input spatial reference to an output spatial reference.
 String generateMessage(int type, int iD)
          Generate a given message from the message id.
 void generateSpRef(IArray pInputTables, ITable pOverlayTable, double growExtentBy, ISpatialReference[] ppSpRef, IEnvelope[] ppExtent, boolean[] pHasMs, double[] pMMin, double[] pMMax, boolean[] pHasZs, double[] pZMin, double[] pZMax)
          Generates a new spatial reference object.
 IActiveView getActiveView()
          Get active view.
 IBasicMap getBasicMap()
          Gets the basic map associated with the application.
 Object getCatalog()
          Returns the catalog object shared between geoprocessing operations.
static String getClsid()
          getClsid.
 IGPEnvironment getEnvironment(IArray pEnvironments, String name)
          Locates a geoprocessing environment with the given name in the given array.
 IEnvelope getExtent(IGPValue pValue, int[] envType)
          Gets the type and value of extent of the given value.
 IFields getFields(IGPValue pValue)
          Returns a collection of field objects contained in the given geoprocessing value object.
 IEnumGPValue getGPLayers()
          Returns an enumeration of current geoprocessing layers.
 IEnumGPValue getGPMapData()
          Returns an enumeration of geoprocessing data.
 ISpatialReference getGPSpRefEnv(IGPEnvironmentManager pEnvMgr, ISpatialReference pSrcSpRef, IEnvelope pNewExtent, double newMMin, double newMMax, double newZMin, double newZMax, Object pWkspFDS)
          Creates the spatial reference from both a source and environment.
 ISpatialReference getGPSpRefEnvEx(IGPEnvironmentManager pEnvMgr, ISpatialReference pSrcSpRef, ISpatialReference pTgtSpRef, IEnvelope pNewExtent, double newMMin, double newMMax, double newZMin, double newZMax, Object pWkspFDS)
          Creates the spatial reference from both a source and environment.
 IEnumGPValue getGPTableViews()
          Returns an enumeration of geoprocessing table views.
 void getGTOperationSet(IGPValue pGTs, ISpatialReference pInSR, ISpatialReference pOutSR, ICompositeGeoTransformation ppGTs)
          Gets the set of geographic transformations.
 Object getGxObject(IDataElement pDataElement)
          Returns the catalog object corresponding to the given data element.
 Object getGxObjectFromLocation(String catalogPath)
          Returns the catalog object from the given catalog path.
 IArray getGxObjects(String catalogPath)
          Returns an array of all catalog objects which correspond to the catalog path.
 IWorkspace getInMemoryWorkspace()
          Get the virtual workspace.
 String getLayerName(IGPValue pValue, String name)
          Get default layer name for given value.
 IMap getMap()
          Gets the map associated with the application.
 IEnumLayer getMapLayers()
          Returns an enumeration of the current layers in the application.
 IEnumTable getMapTables()
          Returns an enumeration of standalone tables in the current map.
 String getMessage(int iD)
          Get a given message.
 IName getNameObject(IDataElement pDataElement)
          Returns a name object corresponding to the object referred to by the given data element.
 IName getNameObjectFromLocation(String locationMoniker)
          Returns a name object corresponding to the object by the location moniker.
 IStatusBar getStatusBar()
          Gets the status bar associated with the application.
 String getUnQualifiedCatalogPath(IGPValue pValue)
          Returns the unqualified path by striping the GDBs database and user names.
 IGPVariableManager getVariableManager()
          Sets the Variable Manager.
 String getWorkspace()
          Sets the path to the current workspace.
 int hashCode()
          the hashcode for this object
 boolean inApplication()
          Indicates if the program is running in an ArcGIS applicaiton.
 IGPMessages internalValidate(IArray pParameters, IArray pParamValues, boolean updateValues, boolean honorDerivedFlag, IGPEnvironmentManager pEnvMgr)
          Performs a validation of the parameters to a GPTool.
 void internalValidateValue(IGPParameter pParameter, Object pValue, boolean updateValue, boolean honorDerivedFlag, IGPEnvironmentManager pEnvMgr, IGPMessage pMessage)
          Performs a validation of the a single parameter to a GPTool.
 boolean isBadMessage(IGPMessages pMessages, int index)
          Tests if a given message within an array of messages is bad.
 boolean isDatasetType(Object pUnknown)
          Returns whether the given object is a dataset.
 boolean isDerived(Object pInput)
          Returns whether the given variable or parameter is derived.
 boolean isGPTableView(IGPValue pValue)
          Returns test if a geoprocessing table views is in fact a table and not from a layer.
 boolean isRefreshCatalogParent()
          Returns whether catalog objects, used by the shared catalog object, are refreshed during geoprocessing operations.
 IDataElement makeDataElement(String catalogPath, IGPDataType pDataType, IDEBrowseOptions pExpandOptions)
          Returns a data element object from the catalog object specified by the given path, data type, and expand options.
 IDataElement makeDataElementFromNameObject(IName name)
          Creates a new data element object from the given name object.
 IArray makeDataElements(String catalogPath, IDEBrowseOptions pBrowseOptions)
          Get data elements from catalog path.
 IGPLayer makeGPLayer(String catalogPath, IGPDataType pDataType)
          Creates a geoprocessing layer object from the given catalog path and of the given geoprocessing data type.
 IGPLayer makeGPLayerFromLayer(ILayer pLayer)
          Creates a geoprocessing layer object based on the given layer object.
 IGPTableView makeGPTableView(String catalogPath, IGPDataType pDataType)
          Returns a geoprocessing table view object corresponding to the given catalog path and of the specified geoprocessing data type.
 IGPTableView makeGPTableViewFromTable(ITable pTable)
          Returns a new geoprocessing table view object from the given table object.
 IGPValue makeGPValueFromObject(Object pUnk)
          Generate an GPValue from an Arc Object.
 ILayer makeLayer(IGPValue pValue, String name, Object pUnkRenderer)
          Creates appropriate layer for the value.
 Object open(IGPValue pValue)
          Returns the dataset of the given value.
 IDataset openDataset(IGPValue pValue)
          Opens the dataset object specified by the given geoprocessing value object.
 IDataset openDatasetFromLocation(String catalogPath)
          Opens the dataset object from the given catalog path.
 IFeatureClass openFeatureClassFromString(String catalogPath)
          Opens a feature class from the given catalog path.
 IFeatureLayer openFeatureLayerFromString(String catalogPath)
          Opens a feature layer from the given catalog path.
 Object openFromString(String nameString)
          Returns the dataset of the given value.
 IRasterDataset openRasterDatasetFromString(String catalogPath)
          Opens a raster dataset object from the given catalog path.
 IRasterLayer openRasterLayerFromString(String catalogPath)
          Opens a raster layer object from the given catalog path.
 ITable openTableFromString(String catalogPath)
          Opens a table from the given catalog path.
 void packGPValue(IGPValue pValue, Object pInput)
          Sets the given geoprocessing value into the given parameter/variable.
 String qualifyOutputCatalogPath(String catalogPath)
          Qualify the catalog path with the GDBs database and user names.
 void qualifyOutputDataElement(IGPValue pValue)
          Qualify the catalog path of the given value with the GDBs database and user names.
 void refreshCatalog(IDataElement pSourceDataElement)
          Refreshes the parent within the catalog of the given data element.
 void refreshView()
          Refreshes the applications active view.
 void releaseInternals()
          Releases all internal objects used prior to releasing this GPUtilities object.
 void removeFromMap(IGPValue pGPValue, String name)
          Removes the data/layers specified by the geoprocessing value object and/or name.
 void removeFromMapEx(IGPValue pGPValue)
          Removes the data/layers specified by the geoprocessing value object from the map.
 void removeInternalData()
          Removes all internal layers and tables.
 void removeInternalLayer(String name)
          Removes the internal layer.
 void removeInternalLayerEx(ILayer pLayer)
          Removes the internal layer.
 void removeInternalTable(String name)
          Removes the internal table.
 void removeInternalTableEx(ITable pTable)
          Removes the internal table.
 void removeInternalValues()
          Removes all of the GPValues returned from MakeGPValueFromObject.
 void rename(IGPValue pSourceGPValue, IGPValue pTargetGPValue)
          Renames the object referred to by the given geoprocessing value object.
 void saveLayer(String catalogPath, ILayer pLayer)
          Saves a layer to a given location on disk.
 void setGridIndex(IGPEnvironmentManager pEnvMgr, IArray pInputTables, double spatialIndex1, double spatialIndex2, double spatialIndex3, Object pUnk, IGeometryDef pGeometryDef)
          Calculates and sets the grid index sizes on the given geometry definition object.
 void setInternalMap(IMap pMap)
          Sets the internal map used by the geoprocessor.
 void setMessage(int type, int iD, int pos, IGPMessages msgs)
          Set a given message from the message id to the messages object.
 void setMessage1Args(int type, int iD, String arg1, int pos, IGPMessages msgs)
          Set a given message from the message id to the messages object.
 void setMessage2Args(int type, int iD, String arg1, String arg2, int pos, IGPMessages msgs)
          Set a given message from the message id to the messages object.
 void setMessageText(int type, int iD, String msg, int pos, IGPMessages msgs)
          Set a given message from the message text to the messages object.
 void setRefreshCatalogParent(boolean pRefresh)
          Returns whether catalog objects, used by the shared catalog object, are refreshed during geoprocessing operations.
 void setupEditSession(IClass pTable)
          Starts an edit session if needed.
 void setVariableManagerByRef(IGPVariableManager ppVariableManager)
          Sets the Variable Manager.
 void setWorkspace(String workPath)
          Sets the path to the current workspace.
 void startEditOperation(IWorkspaceEdit pWorkspace, boolean bHasPrivateEditSession)
          Start edit operation within the application.
 void stopEditOperation(IWorkspaceEdit pWorkspace, String operationLabel)
          Stop edit operation within the application.
 IGPValue unpackGPValue(Object pInput)
          Returns the geoprocessing value object from the given parameter, variable, or value object.
 boolean validateExists(IGPValue pGPValue, boolean checkDerived)
          Verifies that the data referenced by the given geoprocessing value object exists.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

GPUtilities

public GPUtilities()
            throws IOException,
                   UnknownHostException
Constructs a GPUtilities using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

GPUtilities

public GPUtilities(Object obj)
            throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPUtilities theGPUtilities = (GPUtilities) obj;

Construct a GPUtilities using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GPUtilities.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

internalValidate

public IGPMessages internalValidate(IArray pParameters,
                                    IArray pParamValues,
                                    boolean updateValues,
                                    boolean honorDerivedFlag,
                                    IGPEnvironmentManager pEnvMgr)
                             throws IOException,
                                    AutomationException
Performs a validation of the parameters to a GPTool.

Remarks

The InternalValidate method is called during Validate, when it performs checks on required data elements to ensure they exist and are valid. In particular, it verifies data types and their values against data definitions, and if the values are members of a defined domain. InternalValidate also checks geoprocessing environment settings.

Product Availability

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

Specified by:
internalValidate in interface IGPUtilities
Parameters:
pParameters - A reference to a com.esri.arcgis.system.IArray (in)
pParamValues - A reference to a com.esri.arcgis.system.IArray (in)
updateValues - The updateValues (in)
honorDerivedFlag - The honorDerivedFlag (in)
pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPMessages
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

internalValidateValue

public void internalValidateValue(IGPParameter pParameter,
                                  Object pValue,
                                  boolean updateValue,
                                  boolean honorDerivedFlag,
                                  IGPEnvironmentManager pEnvMgr,
                                  IGPMessage pMessage)
                           throws IOException,
                                  AutomationException
Performs a validation of the a single parameter to a GPTool.

Product Availability

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

Specified by:
internalValidateValue in interface IGPUtilities
Parameters:
pParameter - A reference to a com.esri.arcgis.geoprocessing.IGPParameter (in)
pValue - A reference to another Object (IUnknown) (in)
updateValue - The updateValue (in)
honorDerivedFlag - The honorDerivedFlag (in)
pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
pMessage - A reference to a com.esri.arcgis.geodatabase.IGPMessage (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isBadMessage

public boolean isBadMessage(IGPMessages pMessages,
                            int index)
                     throws IOException,
                            AutomationException
Tests if a given message within an array of messages is bad.

Product Availability

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

Specified by:
isBadMessage in interface IGPUtilities
Parameters:
pMessages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
index - The index (in)
Returns:
The pBadMsg
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

generateDefaultOutputValue

public IGPValue generateDefaultOutputValue(IGPEnvironmentManager pEnvMgr,
                                           String functionname,
                                           IGPParameter pOutputParam,
                                           IGPValue pInputValue,
                                           String extension,
                                           int outputFileBaseLimit)
                                    throws IOException,
                                           AutomationException
Generates the default output value and sets its path to an unique name.

Remarks

The GenerateDefaultOutputValue method is called during validation inside IGPFunction_Validate to return an output path as a value object [IGPValue].

Product Availability

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

Specified by:
generateDefaultOutputValue in interface IGPUtilities
Parameters:
pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
functionname - The functionname (in)
pOutputParam - A reference to a com.esri.arcgis.geoprocessing.IGPParameter (in)
pInputValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
extension - The extension (in)
outputFileBaseLimit - The outputFileBaseLimit (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

qualifyOutputDataElement

public void qualifyOutputDataElement(IGPValue pValue)
                              throws IOException,
                                     AutomationException
Qualify the catalog path of the given value with the GDBs database and user names.

Product Availability

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

Specified by:
qualifyOutputDataElement in interface IGPUtilities
Parameters:
pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

qualifyOutputCatalogPath

public String qualifyOutputCatalogPath(String catalogPath)
                                throws IOException,
                                       AutomationException
Qualify the catalog path with the GDBs database and user names.

Product Availability

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

Specified by:
qualifyOutputCatalogPath in interface IGPUtilities
Parameters:
catalogPath - The catalogPath (in)
Returns:
The pQualifiedCatalogPath
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUnQualifiedCatalogPath

public String getUnQualifiedCatalogPath(IGPValue pValue)
                                 throws IOException,
                                        AutomationException
Returns the unqualified path by striping the GDBs database and user names.

Product Availability

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

Specified by:
getUnQualifiedCatalogPath in interface IGPUtilities
Parameters:
pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
Returns:
The path
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWorkspace

public void setWorkspace(String workPath)
                  throws IOException,
                         AutomationException
Sets the path to the current workspace.

Product Availability

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

Supported Platforms

Windows

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

getWorkspace

public String getWorkspace()
                    throws IOException,
                           AutomationException
Sets the path to the current workspace.

Product Availability

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

Supported Platforms

Windows

Specified by:
getWorkspace in interface IGPUtilities
Returns:
The workPath
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCatalog

public Object getCatalog()
                  throws IOException,
                         AutomationException
Returns the catalog object shared between geoprocessing operations.

Product Availability

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

Supported Platforms

Windows

Specified by:
getCatalog in interface IGPUtilities
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRefreshCatalogParent

public boolean isRefreshCatalogParent()
                               throws IOException,
                                      AutomationException
Returns whether catalog objects, used by the shared catalog object, are refreshed during geoprocessing operations.

Product Availability

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

Supported Platforms

Windows

Specified by:
isRefreshCatalogParent in interface IGPUtilities
Returns:
The pRefresh
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRefreshCatalogParent

public void setRefreshCatalogParent(boolean pRefresh)
                             throws IOException,
                                    AutomationException
Returns whether catalog objects, used by the shared catalog object, are refreshed during geoprocessing operations.

Product Availability

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

Supported Platforms

Windows

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

makeDataElement

public IDataElement makeDataElement(String catalogPath,
                                    IGPDataType pDataType,
                                    IDEBrowseOptions pExpandOptions)
                             throws IOException,
                                    AutomationException
Returns a data element object from the catalog object specified by the given path, data type, and expand options.

Product Availability

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

Supported Platforms

Windows

Specified by:
makeDataElement in interface IGPUtilities
Parameters:
catalogPath - The catalogPath (in)
pDataType - A reference to a com.esri.arcgis.geodatabase.IGPDataType (in)
pExpandOptions - A reference to a com.esri.arcgis.geodatabase.IDEBrowseOptions (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IDataElement
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

makeDataElementFromNameObject

public IDataElement makeDataElementFromNameObject(IName name)
                                           throws IOException,
                                                  AutomationException
Creates a new data element object from the given name object.

Product Availability

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

Supported Platforms

Windows

Specified by:
makeDataElementFromNameObject in interface IGPUtilities
Parameters:
name - A reference to a com.esri.arcgis.system.IName (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IDataElement
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

expandDataElement

public void expandDataElement(IDataElement pInDE,
                              IDEBrowseOptions pExpandOptions)
                       throws IOException,
                              AutomationException
Expands the properties of the given data element according to the given expand options.

Product Availability

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

Supported Platforms

Windows

Specified by:
expandDataElement in interface IGPUtilities
Parameters:
pInDE - A reference to a com.esri.arcgis.geodatabase.IDataElement (in)
pExpandOptions - A reference to a com.esri.arcgis.geodatabase.IDEBrowseOptions (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createDataElement

public IDataElement createDataElement(String catalogPath,
                                      IGPDataType pDataType,
                                      String optionalWorkspace)
                               throws IOException,
                                      AutomationException
Creates a new data element object from the catalog object specified by the given path, data type, and optional workspace.

Product Availability

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

Supported Platforms

Windows

Specified by:
createDataElement in interface IGPUtilities
Parameters:
catalogPath - The catalogPath (in)
pDataType - A reference to a com.esri.arcgis.geodatabase.IGPDataType (in)
optionalWorkspace - The optionalWorkspace (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IDataElement
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createFeatureLayer

public IGPValue createFeatureLayer(String catalogPath)
                            throws IOException,
                                   AutomationException
Creates a geoprocessing feature layer object from the catalog path.

Product Availability

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

Supported Platforms

Windows

Specified by:
createFeatureLayer in interface IGPUtilities
Parameters:
catalogPath - The catalogPath (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

openRasterDatasetFromString

public IRasterDataset openRasterDatasetFromString(String catalogPath)
                                           throws IOException,
                                                  AutomationException
Opens a raster dataset object from the given catalog path.

Product Availability

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

Supported Platforms

Windows

Specified by:
openRasterDatasetFromString in interface IGPUtilities
Parameters:
catalogPath - The catalogPath (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IRasterDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

openFeatureClassFromString

public IFeatureClass openFeatureClassFromString(String catalogPath)
                                         throws IOException,
                                                AutomationException
Opens a feature class from the given catalog path.

Remarks

The OpenFeatureClassFromString method creates a FeatureClass object by simply taking in the ArcCatalog path of a feature class as a string.

Product Availability

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

Supported Platforms

Windows

Specified by:
openFeatureClassFromString in interface IGPUtilities
Parameters:
catalogPath - The catalogPath (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IFeatureClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

openTableFromString

public ITable openTableFromString(String catalogPath)
                           throws IOException,
                                  AutomationException
Opens a table from the given catalog path.

Product Availability

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

Supported Platforms

Windows

Specified by:
openTableFromString in interface IGPUtilities
Parameters:
catalogPath - The catalogPath (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

openRasterLayerFromString

public IRasterLayer openRasterLayerFromString(String catalogPath)
                                       throws IOException,
                                              AutomationException
Opens a raster layer object from the given catalog path.

Product Availability

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

Supported Platforms

Windows

Specified by:
openRasterLayerFromString in interface IGPUtilities
Parameters:
catalogPath - The catalogPath (in)
Returns:
A reference to a com.esri.arcgis.carto.IRasterLayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

openFeatureLayerFromString

public IFeatureLayer openFeatureLayerFromString(String catalogPath)
                                         throws IOException,
                                                AutomationException
Opens a feature layer from the given catalog path.

Product Availability

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

Supported Platforms

Windows

Specified by:
openFeatureLayerFromString in interface IGPUtilities
Parameters:
catalogPath - The catalogPath (in)
Returns:
A reference to a com.esri.arcgis.carto.IFeatureLayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createFeatureClassName

public IName createFeatureClassName(String catalogPath)
                             throws IOException,
                                    AutomationException
Creates a feature class name object from the given catalog path.

Remarks

The CreateFeatureClassName method returns a Name object [IName] from the ArcCatalog path string of a feature class.

See the included code sample below.

Product Availability

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

Supported Platforms

Windows

Specified by:
createFeatureClassName in interface IGPUtilities
Parameters:
catalogPath - The catalogPath (in)
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createRasterDatasetName

public IName createRasterDatasetName(String catalogPath)
                              throws IOException,
                                     AutomationException
Creates a raster dataset name object from the given catalog path.

Remarks

The CreateRasterDatasetName method takes in an ArcCatalog path string of a raster dataset and returns a Name object [IName].

See the included code sample below.

Product Availability

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

Supported Platforms

Windows

Specified by:
createRasterDatasetName in interface IGPUtilities
Parameters:
catalogPath - The catalogPath (in)
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createRasterCatalogName

public IName createRasterCatalogName(String catalogPath)
                              throws IOException,
                                     AutomationException
Creates a raster catalog name object from the given catalog path.

Product Availability

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

Supported Platforms

Windows

Specified by:
createRasterCatalogName in interface IGPUtilities
Parameters:
catalogPath - The catalogPath (in)
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createTableName

public IName createTableName(String catalogPath)
                      throws IOException,
                             AutomationException
Creates a table name object from the given catalog path.

Remarks

The CreateTableName method takes in an ArcCatalog path string of a table and returns a Name object [IName].

See the included code sample below.

Product Availability

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

Supported Platforms

Windows

Specified by:
createTableName in interface IGPUtilities
Parameters:
catalogPath - The catalogPath (in)
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

openDataset

public IDataset openDataset(IGPValue pValue)
                     throws IOException,
                            AutomationException
Opens the dataset object specified by the given geoprocessing value object.

Remarks

The OpenDataset method takes in a GPValue object and returns and opens the specified Dataset object. It is typically used inside the Execute method to open the input data.

Product Availability

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

Supported Platforms

Windows

Specified by:
openDataset in interface IGPUtilities
Parameters:
pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

openDatasetFromLocation

public IDataset openDatasetFromLocation(String catalogPath)
                                 throws IOException,
                                        AutomationException
Opens the dataset object from the given catalog path.

Remarks

The OpenDatasetFromLocation method provides a quick way to get a dataset from its location path string. It takes in an ArcCatalog path string and returns a Dataset object [IDataset].

Product Availability

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

Supported Platforms

Windows

Specified by:
openDatasetFromLocation in interface IGPUtilities
Parameters:
catalogPath - The catalogPath (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addToMap

public void addToMap(IGPValue pGPValue,
                     String name,
                     boolean temporary,
                     Object pUnkRenderer)
              throws IOException,
                     AutomationException
Adds the given geoprocessing value object to the application display.

Product Availability

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

Supported Platforms

Windows

Specified by:
addToMap in interface IGPUtilities
Parameters:
pGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
name - The name (in)
temporary - The temporary (in)
pUnkRenderer - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refreshCatalog

public void refreshCatalog(IDataElement pSourceDataElement)
                    throws IOException,
                           AutomationException
Refreshes the parent within the catalog of the given data element.

Remarks

The RefreshCatalog method forces a refresh of the catalog tree after executuion of a geoprocessing operation such as a create or delete.

Refer to the code sample to see how this method can be used.

Product Availability

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

Supported Platforms

Windows

Specified by:
refreshCatalog in interface IGPUtilities
Parameters:
pSourceDataElement - A reference to a com.esri.arcgis.geodatabase.IDataElement (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

exportFeatureClass

public void exportFeatureClass(IDataElement pSourceDataElement,
                               IDataElement pTargetDataElement)
                        throws IOException,
                               AutomationException
Exports the given feature class to a new feature class.

Product Availability

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

Supported Platforms

Windows

Specified by:
exportFeatureClass in interface IGPUtilities
Parameters:
pSourceDataElement - A reference to a com.esri.arcgis.geodatabase.IDataElement (in)
pTargetDataElement - A reference to a com.esri.arcgis.geodatabase.IDataElement (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

delete

public void delete(IGPValue pGPValue)
            throws IOException,
                   AutomationException
Deletes the object referred to by the given geoprocessing value object.

Remarks

The Delete method is typically used in combination with the Exists method to first check existence of a value such as in the case of checking if the OverwriteOutput setting is true or false. A code sample is included below. For an extended code sample refer to the Execute Method section of the Building Geoprocessing Functions technical document.

Product Availability

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

Supported Platforms

Windows

Specified by:
delete in interface IGPUtilities
Parameters:
pGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

rename

public void rename(IGPValue pSourceGPValue,
                   IGPValue pTargetGPValue)
            throws IOException,
                   AutomationException
Renames the object referred to by the given geoprocessing value object.

Product Availability

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

Supported Platforms

Windows

Specified by:
rename in interface IGPUtilities
Parameters:
pSourceGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
pTargetGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

copy

public void copy(IGPValue pSourceGPValue,
                 IGPValue pTargetGPValue)
          throws IOException,
                 AutomationException
Copies the object referred to by the given geoprocessing value object.

Product Availability

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

Supported Platforms

Windows

Specified by:
copy in interface IGPUtilities
Parameters:
pSourceGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
pTargetGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

exists

public boolean exists(IGPValue pGPValue)
               throws IOException,
                      AutomationException
Returns whether the object referred to by the given geoprocessing value object exists.

Remarks

The Exists method checks if a value exists, or has been created. A code sample is included below. For an extended code sample refer to the Execute Method section of the Building Geoprocessing Functions technical document.

Product Availability

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

Supported Platforms

Windows

Specified by:
exists in interface IGPUtilities
Parameters:
pGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
Returns:
The exists
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

compareWildCard

public boolean compareWildCard(String wildCard,
                               String data)
                        throws IOException,
                               AutomationException
Returns whether the given string satisfies the given wildcard string.

Product Availability

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

Supported Platforms

Windows

Specified by:
compareWildCard in interface IGPUtilities
Parameters:
wildCard - The wildCard (in)
data - The data (in)
Returns:
The matched
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNameObject

public IName getNameObject(IDataElement pDataElement)
                    throws IOException,
                           AutomationException
Returns a name object corresponding to the object referred to by the given data element.

Product Availability

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

Supported Platforms

Windows

Specified by:
getNameObject in interface IGPUtilities
Parameters:
pDataElement - A reference to a com.esri.arcgis.geodatabase.IDataElement (in)
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNameObjectFromLocation

public IName getNameObjectFromLocation(String locationMoniker)
                                throws IOException,
                                       AutomationException
Returns a name object corresponding to the object by the location moniker.

Product Availability

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

Supported Platforms

Windows

Specified by:
getNameObjectFromLocation in interface IGPUtilities
Parameters:
locationMoniker - The locationMoniker (in)
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGxObjectFromLocation

public Object getGxObjectFromLocation(String catalogPath)
                               throws IOException,
                                      AutomationException
Returns the catalog object from the given catalog path.

Product Availability

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

Supported Platforms

Windows

Specified by:
getGxObjectFromLocation in interface IGPUtilities
Parameters:
catalogPath - The catalogPath (in)
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

fieldExists

public boolean fieldExists(IGPValue pGPValue,
                           IField pField)
                    throws IOException,
                           AutomationException
Returns whether the given field exists within the given geoprocessing value object.

Product Availability

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

Supported Platforms

Windows

Specified by:
fieldExists in interface IGPUtilities
Parameters:
pGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
pField - A reference to a com.esri.arcgis.geodatabase.IField (in)
Returns:
The pExists
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findField

public IField findField(IGPValue pGPValue,
                        String name)
                 throws IOException,
                        AutomationException
Returns the field object with the specified name in the given geoprocessing value object.

Remarks

The FindField method returns the field object of the specified name in the given geoprocessing value object.

Product Availability

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

Supported Platforms

Windows

Specified by:
findField in interface IGPUtilities
Parameters:
pGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
name - The name (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IField
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMapLayers

public IEnumLayer getMapLayers()
                        throws IOException,
                               AutomationException
Returns an enumeration of the current layers in the application.

Product Availability

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

Supported Platforms

Windows

Specified by:
getMapLayers in interface IGPUtilities
Returns:
A reference to a com.esri.arcgis.carto.IEnumLayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findMapLayer

public ILayer findMapLayer(String name)
                    throws IOException,
                           AutomationException
Returns a layer with the given name.

Product Availability

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

Supported Platforms

Windows

Specified by:
findMapLayer in interface IGPUtilities
Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.carto.ILayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findMapLayer2

public IGPLayer findMapLayer2(String name,
                              ILayer[] ppLayer)
                       throws IOException,
                              AutomationException
Returns a layer and geoprocessing layer with the given name.

Product Availability

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

Supported Platforms

Windows

Specified by:
findMapLayer2 in interface IGPUtilities
Parameters:
name - The name (in)
ppLayer - A reference to a com.esri.arcgis.carto.ILayer (out: use single element array)
Returns:
A reference to a com.esri.arcgis.datasourcesfile.IGPLayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGPLayers

public IEnumGPValue getGPLayers()
                         throws IOException,
                                AutomationException
Returns an enumeration of current geoprocessing layers.

Product Availability

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

Supported Platforms

Windows

Specified by:
getGPLayers in interface IGPUtilities
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumGPValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

makeGPLayer

public IGPLayer makeGPLayer(String catalogPath,
                            IGPDataType pDataType)
                     throws IOException,
                            AutomationException
Creates a geoprocessing layer object from the given catalog path and of the given geoprocessing data type.

Product Availability

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

Supported Platforms

Windows

Specified by:
makeGPLayer in interface IGPUtilities
Parameters:
catalogPath - The catalogPath (in)
pDataType - A reference to a com.esri.arcgis.geodatabase.IGPDataType (in)
Returns:
A reference to a com.esri.arcgis.datasourcesfile.IGPLayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEnvironment

public IGPEnvironment getEnvironment(IArray pEnvironments,
                                     String name)
                              throws IOException,
                                     AutomationException
Locates a geoprocessing environment with the given name in the given array.

Remarks

The GetEnvironment property provides access to any geoprocessing environments for an application or session.

Refer to the code sample to see how to use this property.

Product Availability

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

Supported Platforms

Windows

Specified by:
getEnvironment in interface IGPUtilities
Parameters:
pEnvironments - A reference to a com.esri.arcgis.system.IArray (in)
name - The name (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IGPEnvironment
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addInternalLayer

public void addInternalLayer(ILayer pLayer)
                      throws IOException,
                             AutomationException
Adds a layer object to the geoprocessing utility object.

Product Availability

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

Supported Platforms

Windows

Specified by:
addInternalLayer in interface IGPUtilities
Parameters:
pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addInternalLayer2

public void addInternalLayer2(ILayer pLayer,
                              IGPLayer pGPLayer)
                       throws IOException,
                              AutomationException
Adds a layer object and geoprocessing layer object to the geoprocessing utility object.

Product Availability

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

Supported Platforms

Windows

Specified by:
addInternalLayer2 in interface IGPUtilities
Parameters:
pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
pGPLayer - A reference to a com.esri.arcgis.datasourcesfile.IGPLayer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

makeGPLayerFromLayer

public IGPLayer makeGPLayerFromLayer(ILayer pLayer)
                              throws IOException,
                                     AutomationException
Creates a geoprocessing layer object based on the given layer object.

Product Availability

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

Supported Platforms

Windows

Specified by:
makeGPLayerFromLayer in interface IGPUtilities
Parameters:
pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Returns:
A reference to a com.esri.arcgis.datasourcesfile.IGPLayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createParentFromCatalogPath

public IName createParentFromCatalogPath(String catalogPath)
                                  throws IOException,
                                         AutomationException
Returns a name object corresponding to the parent object of the specified catalog path.

Product Availability

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

Supported Platforms

Windows

Specified by:
createParentFromCatalogPath in interface IGPUtilities
Parameters:
catalogPath - The catalogPath (in)
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

unpackGPValue

public IGPValue unpackGPValue(Object pInput)
                       throws IOException,
                              AutomationException
Returns the geoprocessing value object from the given parameter, variable, or value object.

Remarks

The UnpackGPValue method is used to access the value from a specific function parameter. A code sample is included below. For an extended code sample refer to the Validate Method section of the Building Geoprocessing Functions technical document.

Product Availability

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

Supported Platforms

Windows

Specified by:
unpackGPValue in interface IGPUtilities
Parameters:
pInput - A reference to another Object (IUnknown) (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

decodeRasterLayer

public void decodeRasterLayer(IGPValue pValue,
                              IRasterDataset[] ppRD)
                       throws IOException,
                              AutomationException
Returns the raster dataset specified by the given geoprocessing value object.

Product Availability

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

Supported Platforms

Windows

Specified by:
decodeRasterLayer in interface IGPUtilities
Parameters:
pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
ppRD - A reference to a com.esri.arcgis.geodatabase.IRasterDataset (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

decodeFeatureLayer

public void decodeFeatureLayer(IGPValue pValue,
                               IFeatureClass[] ppFC,
                               IQueryFilter[] ppQF)
                        throws IOException,
                               AutomationException
Returns the feature class and query filter specified by the given geoprocessing value object.

Remarks

The DecodeFeatureLayer method is a wrapper function that quickly and easily creates a value from an object. It is called inside IGPFuncion_Validate .

Product Availability

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

Supported Platforms

Windows

Specified by:
decodeFeatureLayer in interface IGPUtilities
Parameters:
pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
ppFC - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (out: use single element array)
ppQF - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

decodeTableView

public void decodeTableView(IGPValue pValue,
                            ITable[] ppTable,
                            IQueryFilter[] ppQF)
                     throws IOException,
                            AutomationException
Returns the table and query filter specified by the given geoprocessing value object.

Remarks

The DecodeTableView method is a wrapper function that quickly and easily creates a value from an object. Like the DecodeFeatureLayer, it is called inside IGPFuncion_Validate .

Product Availability

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

Supported Platforms

Windows

Specified by:
decodeTableView in interface IGPUtilities
Parameters:
pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
ppTable - A reference to a com.esri.arcgis.geodatabase.ITable (out: use single element array)
ppQF - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

decodeLayer

public ILayer decodeLayer(IGPValue pValue)
                   throws IOException,
                          AutomationException
Returns the layer object specified by the given geoprocessing value object.

Product Availability

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

Supported Platforms

Windows

Specified by:
decodeLayer in interface IGPUtilities
Parameters:
pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
Returns:
A reference to a com.esri.arcgis.carto.ILayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

decodeStandaloneTable

public IStandaloneTable decodeStandaloneTable(IGPValue pValue)
                                       throws IOException,
                                              AutomationException
Returns the standalone table object specified by the given geoprocessing value object.

Product Availability

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

Supported Platforms

Windows

Specified by:
decodeStandaloneTable in interface IGPUtilities
Parameters:
pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
Returns:
A reference to a com.esri.arcgis.carto.IStandaloneTable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

decodeDETable

public IDETable decodeDETable(IGPValue pValue)
                       throws IOException,
                              AutomationException
Returns the table data element specified by the given geoprocessing value object.

Remarks

The DecodeDETable method is a wrapper function to quickly create a value from an object. It returns the table data element specified by the given geoprocessing value object. For a code sample see below.

Product Availability

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

Supported Platforms

Windows

Specified by:
decodeDETable in interface IGPUtilities
Parameters:
pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IDETable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

releaseInternals

public void releaseInternals()
                      throws IOException,
                             AutomationException
Releases all internal objects used prior to releasing this GPUtilities object.

Product Availability

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

Supported Platforms

Windows

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

getMapTables

public IEnumTable getMapTables()
                        throws IOException,
                               AutomationException
Returns an enumeration of standalone tables in the current map.

Product Availability

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

Supported Platforms

Windows

Specified by:
getMapTables in interface IGPUtilities
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumTable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findMapTable

public ITable findMapTable(String name)
                    throws IOException,
                           AutomationException
Locates a table with the specified name.

Product Availability

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

Supported Platforms

Windows

Specified by:
findMapTable in interface IGPUtilities
Parameters:
name - The name (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ITable
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findMapTable2

public IGPTableView findMapTable2(String name,
                                  ITable[] ppTable)
                           throws IOException,
                                  AutomationException
Locates a table with the specified name and returns the table and geoprocessing table view objects.

Product Availability

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

Supported Platforms

Windows

Specified by:
findMapTable2 in interface IGPUtilities
Parameters:
name - The name (in)
ppTable - A reference to a com.esri.arcgis.geodatabase.ITable (out: use single element array)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IGPTableView
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGPTableViews

public IEnumGPValue getGPTableViews()
                             throws IOException,
                                    AutomationException
Returns an enumeration of geoprocessing table views.

Product Availability

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

Supported Platforms

Windows

Specified by:
getGPTableViews in interface IGPUtilities
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumGPValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isGPTableView

public boolean isGPTableView(IGPValue pValue)
                      throws IOException,
                             AutomationException
Returns test if a geoprocessing table views is in fact a table and not from a layer.

Product Availability

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

Specified by:
isGPTableView in interface IGPUtilities
Parameters:
pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
Returns:
The pResult
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

makeGPTableView

public IGPTableView makeGPTableView(String catalogPath,
                                    IGPDataType pDataType)
                             throws IOException,
                                    AutomationException
Returns a geoprocessing table view object corresponding to the given catalog path and of the specified geoprocessing data type.

Product Availability

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

Supported Platforms

Windows

Specified by:
makeGPTableView in interface IGPUtilities
Parameters:
catalogPath - The catalogPath (in)
pDataType - A reference to a com.esri.arcgis.geodatabase.IGPDataType (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IGPTableView
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addInternalTable

public void addInternalTable(ITable pTable)
                      throws IOException,
                             AutomationException
Adds the given table to the utility object's list of tables.

Product Availability

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

Supported Platforms

Windows

Specified by:
addInternalTable in interface IGPUtilities
Parameters:
pTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addInternalTable2

public void addInternalTable2(ITable pTable,
                              IGPTableView pGPTableView)
                       throws IOException,
                              AutomationException
Adds the given table to the utility object's list of tables.

Product Availability

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

Supported Platforms

Windows

Specified by:
addInternalTable2 in interface IGPUtilities
Parameters:
pTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
pGPTableView - A reference to a com.esri.arcgis.geoprocessing.IGPTableView (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

makeGPTableViewFromTable

public IGPTableView makeGPTableViewFromTable(ITable pTable)
                                      throws IOException,
                                             AutomationException
Returns a new geoprocessing table view object from the given table object.

Product Availability

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

Supported Platforms

Windows

Specified by:
makeGPTableViewFromTable in interface IGPUtilities
Parameters:
pTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IGPTableView
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFields

public IFields getFields(IGPValue pValue)
                  throws IOException,
                         AutomationException
Returns a collection of field objects contained in the given geoprocessing value object.

Product Availability

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

Supported Platforms

Windows

Specified by:
getFields in interface IGPUtilities
Parameters:
pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IFields
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canAddToMap

public boolean canAddToMap()
                    throws IOException,
                           AutomationException
Returns whether datasets can be added to the current application display.

Product Availability

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

Supported Platforms

Windows

Specified by:
canAddToMap in interface IGPUtilities
Returns:
The pCanAddToMap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

generateSpRef

public void generateSpRef(IArray pInputTables,
                          ITable pOverlayTable,
                          double growExtentBy,
                          ISpatialReference[] ppSpRef,
                          IEnvelope[] ppExtent,
                          boolean[] pHasMs,
                          double[] pMMin,
                          double[] pMMax,
                          boolean[] pHasZs,
                          double[] pZMin,
                          double[] pZMax)
                   throws IOException,
                          AutomationException
Generates a new spatial reference object.

Product Availability

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

Supported Platforms

Windows

Specified by:
generateSpRef in interface IGPUtilities
Parameters:
pInputTables - A reference to a com.esri.arcgis.system.IArray (in)
pOverlayTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
growExtentBy - The growExtentBy (in)
ppSpRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (out: use single element array)
ppExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (out: use single element array)
pHasMs - The pHasMs (out: use single element array)
pMMin - The pMMin (out: use single element array)
pMMax - The pMMax (out: use single element array)
pHasZs - The pHasZs (out: use single element array)
pZMin - The pZMin (out: use single element array)
pZMax - The pZMax (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGridIndex

public void setGridIndex(IGPEnvironmentManager pEnvMgr,
                         IArray pInputTables,
                         double spatialIndex1,
                         double spatialIndex2,
                         double spatialIndex3,
                         Object pUnk,
                         IGeometryDef pGeometryDef)
                  throws IOException,
                         AutomationException
Calculates and sets the grid index sizes on the given geometry definition object.

Product Availability

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

Supported Platforms

Windows

Specified by:
setGridIndex in interface IGPUtilities
Parameters:
pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
pInputTables - A reference to a com.esri.arcgis.system.IArray (in)
spatialIndex1 - The spatialIndex1 (in)
spatialIndex2 - The spatialIndex2 (in)
spatialIndex3 - The spatialIndex3 (in)
pUnk - A reference to another Object (IUnknown) (in)
pGeometryDef - A reference to a com.esri.arcgis.geodatabase.IGeometryDef (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDatasetType

public boolean isDatasetType(Object pUnknown)
                      throws IOException,
                             AutomationException
Returns whether the given object is a dataset.

Product Availability

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

Supported Platforms

Windows

Specified by:
isDatasetType in interface IGPUtilities
Parameters:
pUnknown - A reference to another Object (IUnknown) (in)
Returns:
The pIsDataset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeFromMap

public void removeFromMap(IGPValue pGPValue,
                          String name)
                   throws IOException,
                          AutomationException
Removes the data/layers specified by the geoprocessing value object and/or name.

Product Availability

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

Supported Platforms

Windows

Specified by:
removeFromMap in interface IGPUtilities
Parameters:
pGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDerived

public boolean isDerived(Object pInput)
                  throws IOException,
                         AutomationException
Returns whether the given variable or parameter is derived.

Product Availability

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

Supported Platforms

Windows

Specified by:
isDerived in interface IGPUtilities
Parameters:
pInput - A reference to another Object (IUnknown) (in)
Returns:
The pDerived
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refreshView

public void refreshView()
                 throws IOException,
                        AutomationException
Refreshes the applications active view.

Product Availability

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

Supported Platforms

Windows

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

packGPValue

public void packGPValue(IGPValue pValue,
                        Object pInput)
                 throws IOException,
                        AutomationException
Sets the given geoprocessing value into the given parameter/variable.

Remarks

The PackGPValue method is used to assign, for example an output value to a specific function parameter. such as a derived output. A code sample is included below. For an extended code sample refer to the Validate Method section of the Building Geoprocessing Functions technical document.

Product Availability

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

Supported Platforms

Windows

Specified by:
packGPValue in interface IGPUtilities
Parameters:
pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
pInput - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createParameterValue

public IGPValue createParameterValue(String text,
                                     IGPDataType pDataType,
                                     int direction)
                              throws IOException,
                                     AutomationException
Creates a geoprocessing value object of the given data type from the given string.

Product Availability

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

Supported Platforms

Windows

Specified by:
createParameterValue in interface IGPUtilities
Parameters:
text - The text (in)
pDataType - A reference to a com.esri.arcgis.geodatabase.IGPDataType (in)
direction - A com.esri.arcgis.geoprocessing.esriGPParameterDirection constant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

validateExists

public boolean validateExists(IGPValue pGPValue,
                              boolean checkDerived)
                       throws IOException,
                              AutomationException
Verifies that the data referenced by the given geoprocessing value object exists.

Product Availability

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

Supported Platforms

Windows

Specified by:
validateExists in interface IGPUtilities
Parameters:
pGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
checkDerived - The checkDerived (in)
Returns:
The exists
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGxObject

public Object getGxObject(IDataElement pDataElement)
                   throws IOException,
                          AutomationException
Returns the catalog object corresponding to the given data element.

Product Availability

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

Supported Platforms

Windows

Specified by:
getGxObject in interface IGPUtilities
Parameters:
pDataElement - A reference to a com.esri.arcgis.geodatabase.IDataElement (in)
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGxObjects

public IArray getGxObjects(String catalogPath)
                    throws IOException,
                           AutomationException
Returns an array of all catalog objects which correspond to the catalog path.

Product Availability

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

Supported Platforms

Windows

Specified by:
getGxObjects in interface IGPUtilities
Parameters:
catalogPath - The catalogPath (in)
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

makeDataElements

public IArray makeDataElements(String catalogPath,
                               IDEBrowseOptions pBrowseOptions)
                        throws IOException,
                               AutomationException
Get data elements from catalog path.

Product Availability

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

Supported Platforms

Windows

Specified by:
makeDataElements in interface IGPUtilities
Parameters:
catalogPath - The catalogPath (in)
pBrowseOptions - A reference to a com.esri.arcgis.geodatabase.IDEBrowseOptions (in)
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGPMapData

public IEnumGPValue getGPMapData()
                          throws IOException,
                                 AutomationException
Returns an enumeration of geoprocessing data.

Product Availability

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

Supported Platforms

Windows

Specified by:
getGPMapData in interface IGPUtilities
Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumGPValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

makeGPValueFromObject

public IGPValue makeGPValueFromObject(Object pUnk)
                               throws IOException,
                                      AutomationException
Generate an GPValue from an Arc Object.

Product Availability

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

Specified by:
makeGPValueFromObject in interface IGPUtilities
Parameters:
pUnk - A reference to another Object (IUnknown) (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeInternalValues

public void removeInternalValues()
                          throws IOException,
                                 AutomationException
Removes all of the GPValues returned from MakeGPValueFromObject.

Product Availability

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

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

removeInternalLayer

public void removeInternalLayer(String name)
                         throws IOException,
                                AutomationException
Removes the internal layer.

Product Availability

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

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

removeInternalTable

public void removeInternalTable(String name)
                         throws IOException,
                                AutomationException
Removes the internal table.

Product Availability

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

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

decodeRaster

public IRaster decodeRaster(IGPValue pValue)
                     throws IOException,
                            AutomationException
Returns the raster specified by the given geoprocessing value object.

Product Availability

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

Specified by:
decodeRaster in interface IGPUtilities
Parameters:
pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IRaster
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGPSpRefEnv

public ISpatialReference getGPSpRefEnv(IGPEnvironmentManager pEnvMgr,
                                       ISpatialReference pSrcSpRef,
                                       IEnvelope pNewExtent,
                                       double newMMin,
                                       double newMMax,
                                       double newZMin,
                                       double newZMax,
                                       Object pWkspFDS)
                                throws IOException,
                                       AutomationException
Creates the spatial reference from both a source and environment.

Remarks

The GetGPSpRefEnv method takes in a pEnvMgr and a pSrcSpRef object and returns a SpatialReference object.

Product Availability

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

Specified by:
getGPSpRefEnv in interface IGPUtilities
Parameters:
pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
pSrcSpRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
pNewExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
newMMin - The newMMin (in)
newMMax - The newMMax (in)
newZMin - The newZMin (in)
newZMax - The newZMax (in)
pWkspFDS - A reference to another Object (IUnknown) (in)
Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeInternalLayerEx

public void removeInternalLayerEx(ILayer pLayer)
                           throws IOException,
                                  AutomationException
Removes the internal layer.

Product Availability

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

Specified by:
removeInternalLayerEx in interface IGPUtilities
Parameters:
pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeInternalTableEx

public void removeInternalTableEx(ITable pTable)
                           throws IOException,
                                  AutomationException
Removes the internal table.

Product Availability

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

Specified by:
removeInternalTableEx in interface IGPUtilities
Parameters:
pTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

open

public Object open(IGPValue pValue)
            throws IOException,
                   AutomationException
Returns the dataset of the given value.

Product Availability

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

Specified by:
open in interface IGPUtilities2
Parameters:
pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

saveLayer

public void saveLayer(String catalogPath,
                      ILayer pLayer)
               throws IOException,
                      AutomationException
Saves a layer to a given location on disk.

Product Availability

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

Specified by:
saveLayer in interface IGPUtilities2
Parameters:
catalogPath - The catalogPath (in)
pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getActiveView

public IActiveView getActiveView()
                          throws IOException,
                                 AutomationException
Get active view.

Product Availability

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

Specified by:
getActiveView in interface IGPUtilities2
Returns:
A reference to a com.esri.arcgis.carto.IActiveView
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMap

public IMap getMap()
            throws IOException,
                   AutomationException
Gets the map associated with the application.

Product Availability

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

Specified by:
getMap in interface IGPUtilities2
Returns:
A reference to a com.esri.arcgis.carto.IMap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBasicMap

public IBasicMap getBasicMap()
                      throws IOException,
                             AutomationException
Gets the basic map associated with the application.

Product Availability

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

Specified by:
getBasicMap in interface IGPUtilities2
Returns:
A reference to a com.esri.arcgis.carto.IBasicMap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

inApplication

public boolean inApplication()
                      throws IOException,
                             AutomationException
Indicates if the program is running in an ArcGIS applicaiton.

Product Availability

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

Specified by:
inApplication in interface IGPUtilities2
Returns:
The pInApplication
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

makeLayer

public ILayer makeLayer(IGPValue pValue,
                        String name,
                        Object pUnkRenderer)
                 throws IOException,
                        AutomationException
Creates appropriate layer for the value.

Product Availability

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

Specified by:
makeLayer in interface IGPUtilities2
Parameters:
pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
name - The name (in)
pUnkRenderer - A reference to another Object (IUnknown) (in)
Returns:
A reference to a com.esri.arcgis.carto.ILayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStatusBar

public IStatusBar getStatusBar()
                        throws IOException,
                               AutomationException
Gets the status bar associated with the application.

Product Availability

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

Specified by:
getStatusBar in interface IGPUtilities2
Returns:
A reference to a com.esri.arcgis.system.IStatusBar
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

startEditOperation

public void startEditOperation(IWorkspaceEdit pWorkspace,
                               boolean bHasPrivateEditSession)
                        throws IOException,
                               AutomationException
Start edit operation within the application.

Product Availability

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

Specified by:
startEditOperation in interface IGPUtilities2
Parameters:
pWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspaceEdit (in)
bHasPrivateEditSession - The bHasPrivateEditSession (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

abortEditOperation

public void abortEditOperation(IWorkspaceEdit pWorkspace)
                        throws IOException,
                               AutomationException
Abort edit operation within the application.

Product Availability

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

Specified by:
abortEditOperation in interface IGPUtilities2
Parameters:
pWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspaceEdit (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

stopEditOperation

public void stopEditOperation(IWorkspaceEdit pWorkspace,
                              String operationLabel)
                       throws IOException,
                              AutomationException
Stop edit operation within the application.

Product Availability

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

Specified by:
stopEditOperation in interface IGPUtilities2
Parameters:
pWorkspace - A reference to a com.esri.arcgis.geodatabase.IWorkspaceEdit (in)
operationLabel - The operationLabel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVariableManagerByRef

public void setVariableManagerByRef(IGPVariableManager ppVariableManager)
                             throws IOException,
                                    AutomationException
Sets the Variable Manager.

Product Availability

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

Specified by:
setVariableManagerByRef in interface IGPUtilities2
Parameters:
ppVariableManager - A reference to a com.esri.arcgis.geoprocessing.IGPVariableManager (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVariableManager

public IGPVariableManager getVariableManager()
                                      throws IOException,
                                             AutomationException
Sets the Variable Manager.

Product Availability

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

Specified by:
getVariableManager in interface IGPUtilities2
Returns:
A reference to a com.esri.arcgis.geoprocessing.IGPVariableManager
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

generateGeographicTransformDomain

public void generateGeographicTransformDomain(Object iUnk,
                                              IGPCodedValueDomain pGTDomain,
                                              ISpatialReference pInSR,
                                              ISpatialReference pOutSR,
                                              IGPMessages pMessages)
                                       throws IOException,
                                              AutomationException
Generate the matching geographic transform domain from an input spatial reference to an output spatial reference.

Product Availability

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

Specified by:
generateGeographicTransformDomain in interface IGPUtilities2
Parameters:
iUnk - A reference to another Object (IUnknown) (in)
pGTDomain - A reference to a com.esri.arcgis.geodatabase.IGPCodedValueDomain (in)
pInSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
pOutSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
pMessages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGTOperationSet

public void getGTOperationSet(IGPValue pGTs,
                              ISpatialReference pInSR,
                              ISpatialReference pOutSR,
                              ICompositeGeoTransformation ppGTs)
                       throws IOException,
                              AutomationException
Gets the set of geographic transformations.

Product Availability

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

Specified by:
getGTOperationSet in interface IGPUtilities2
Parameters:
pGTs - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
pInSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
pOutSR - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
ppGTs - A reference to a com.esri.arcgis.geometry.ICompositeGeoTransformation (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent(IGPValue pValue,
                           int[] envType)
                    throws IOException,
                           AutomationException
Gets the type and value of extent of the given value.

Product Availability

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

Specified by:
getExtent in interface IGPUtilities2
Parameters:
pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
envType - A com.esri.arcgis.geoprocessing.esriGPExtentEnum constant (out: use single element array)
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGPSpRefEnvEx

public ISpatialReference getGPSpRefEnvEx(IGPEnvironmentManager pEnvMgr,
                                         ISpatialReference pSrcSpRef,
                                         ISpatialReference pTgtSpRef,
                                         IEnvelope pNewExtent,
                                         double newMMin,
                                         double newMMax,
                                         double newZMin,
                                         double newZMax,
                                         Object pWkspFDS)
                                  throws IOException,
                                         AutomationException
Creates the spatial reference from both a source and environment.

Product Availability

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

Specified by:
getGPSpRefEnvEx in interface IGPUtilities2
Parameters:
pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
pSrcSpRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
pTgtSpRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
pNewExtent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
newMMin - The newMMin (in)
newMMax - The newMMax (in)
newZMin - The newZMin (in)
newZMax - The newZMax (in)
pWkspFDS - A reference to another Object (IUnknown) (in)
Returns:
A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createToolboxFromFactory

public void createToolboxFromFactory(String alias,
                                     String location,
                                     String toolboxName)
                              throws IOException,
                                     AutomationException
Creates a toolbox at the given location for a function factory of a given alias.

Product Availability

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

Specified by:
createToolboxFromFactory in interface IGPUtilities2
Parameters:
alias - The alias (in)
location - The location (in)
toolboxName - The toolboxName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInternalMap

public void setInternalMap(IMap pMap)
                    throws IOException,
                           AutomationException
Sets the internal map used by the geoprocessor.

Product Availability

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

Specified by:
setInternalMap in interface IGPUtilities2
Parameters:
pMap - A reference to a com.esri.arcgis.carto.IMap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerName

public String getLayerName(IGPValue pValue,
                           String name)
                    throws IOException,
                           AutomationException
Get default layer name for given value.

Product Availability

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

Specified by:
getLayerName in interface IGPUtilities2
Parameters:
pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
name - The name (in)
Returns:
The pName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeInternalData

public void removeInternalData()
                        throws IOException,
                               AutomationException
Removes all internal layers and tables.

Product Availability

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

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

getInMemoryWorkspace

public IWorkspace getInMemoryWorkspace()
                                throws IOException,
                                       AutomationException
Get the virtual workspace.

Product Availability

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

Specified by:
getInMemoryWorkspace in interface IGPUtilities2
Returns:
A reference to a com.esri.arcgis.geodatabase.IWorkspace
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

clearInMemoryWorkspace

public void clearInMemoryWorkspace()
                            throws IOException,
                                   AutomationException
Clear the virtual workspace.

Product Availability

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

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

openFromString

public Object openFromString(String nameString)
                      throws IOException,
                             AutomationException
Returns the dataset of the given value.

Product Availability

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

Specified by:
openFromString in interface IGPUtilities2
Parameters:
nameString - The nameString (in)
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setupEditSession

public void setupEditSession(IClass pTable)
                      throws IOException,
                             AutomationException
Starts an edit session if needed.

Product Availability

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

Specified by:
setupEditSession in interface IGPUtilities2
Parameters:
pTable - A reference to a com.esri.arcgis.geodatabase.IClass (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

cleanupEditSession

public void cleanupEditSession(boolean abort)
                        throws IOException,
                               AutomationException
Cleans up any edit session.

Product Availability

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

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

removeFromMapEx

public void removeFromMapEx(IGPValue pGPValue)
                     throws IOException,
                            AutomationException
Removes the data/layers specified by the geoprocessing value object from the map.

Product Availability

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

Specified by:
removeFromMapEx in interface IGPUtilities2
Parameters:
pGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addToMapEx

public void addToMapEx(IGPValue pGPValue,
                       String name,
                       boolean temporary,
                       Object pUnkRenderer,
                       boolean visible)
                throws IOException,
                       AutomationException
Adds the given geoprocessing value object to the application display.

Product Availability

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

Specified by:
addToMapEx in interface IGPUtilities2
Parameters:
pGPValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
name - The name (in)
temporary - The temporary (in)
pUnkRenderer - A reference to another Object (IUnknown) (in)
visible - The visible (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMessage

public String getMessage(int iD)
                  throws IOException,
                         AutomationException
Get a given message.

Product Availability

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

Specified by:
getMessage in interface IGPMessageManager
Parameters:
iD - The iD (in)
Returns:
The msg
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

generateMessage

public String generateMessage(int type,
                              int iD)
                       throws IOException,
                              AutomationException
Generate a given message from the message id.

Product Availability

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

Specified by:
generateMessage in interface IGPMessageManager
Parameters:
type - A com.esri.arcgis.geodatabase.esriGPMessageType constant (in)
iD - The iD (in)
Returns:
The msg
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addMessage

public void addMessage(int type,
                       int iD,
                       IGPMessages msgs)
                throws IOException,
                       AutomationException
Add a given message from the message id to the messages object.

Product Availability

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

Specified by:
addMessage in interface IGPMessageManager
Parameters:
type - A com.esri.arcgis.geodatabase.esriGPMessageType constant (in)
iD - The iD (in)
msgs - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addMessage1Args

public void addMessage1Args(int type,
                            int iD,
                            String arg1,
                            IGPMessages msgs)
                     throws IOException,
                            AutomationException
Add a given message from the message id to the messages object.

Product Availability

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

Specified by:
addMessage1Args in interface IGPMessageManager
Parameters:
type - A com.esri.arcgis.geodatabase.esriGPMessageType constant (in)
iD - The iD (in)
arg1 - The arg1 (in)
msgs - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addMessage2Args

public void addMessage2Args(int type,
                            int iD,
                            String arg1,
                            String arg2,
                            IGPMessages msgs)
                     throws IOException,
                            AutomationException
Add a given message from the message id to the messages object.

Product Availability

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

Specified by:
addMessage2Args in interface IGPMessageManager
Parameters:
type - A com.esri.arcgis.geodatabase.esriGPMessageType constant (in)
iD - The iD (in)
arg1 - The arg1 (in)
arg2 - The arg2 (in)
msgs - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addMessageText

public void addMessageText(int type,
                           int iD,
                           String msg,
                           IGPMessages msgs)
                    throws IOException,
                           AutomationException
Add a given message from the message text to the messages object.

Product Availability

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

Specified by:
addMessageText in interface IGPMessageManager
Parameters:
type - A com.esri.arcgis.geodatabase.esriGPMessageType constant (in)
iD - The iD (in)
msg - The msg (in)
msgs - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMessage

public void setMessage(int type,
                       int iD,
                       int pos,
                       IGPMessages msgs)
                throws IOException,
                       AutomationException
Set a given message from the message id to the messages object.

Product Availability

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

Specified by:
setMessage in interface IGPMessageManager
Parameters:
type - A com.esri.arcgis.geodatabase.esriGPMessageType constant (in)
iD - The iD (in)
pos - The pos (in)
msgs - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMessage1Args

public void setMessage1Args(int type,
                            int iD,
                            String arg1,
                            int pos,
                            IGPMessages msgs)
                     throws IOException,
                            AutomationException
Set a given message from the message id to the messages object.

Product Availability

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

Specified by:
setMessage1Args in interface IGPMessageManager
Parameters:
type - A com.esri.arcgis.geodatabase.esriGPMessageType constant (in)
iD - The iD (in)
arg1 - The arg1 (in)
pos - The pos (in)
msgs - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMessage2Args

public void setMessage2Args(int type,
                            int iD,
                            String arg1,
                            String arg2,
                            int pos,
                            IGPMessages msgs)
                     throws IOException,
                            AutomationException
Set a given message from the message id to the messages object.

Product Availability

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

Specified by:
setMessage2Args in interface IGPMessageManager
Parameters:
type - A com.esri.arcgis.geodatabase.esriGPMessageType constant (in)
iD - The iD (in)
arg1 - The arg1 (in)
arg2 - The arg2 (in)
pos - The pos (in)
msgs - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMessageText

public void setMessageText(int type,
                           int iD,
                           String msg,
                           int pos,
                           IGPMessages msgs)
                    throws IOException,
                           AutomationException
Set a given message from the message text to the messages object.

Product Availability

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

Specified by:
setMessageText in interface IGPMessageManager
Parameters:
type - A com.esri.arcgis.geodatabase.esriGPMessageType constant (in)
iD - The iD (in)
msg - The msg (in)
pos - The pos (in)
msgs - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

chainMessage

public void chainMessage(int type,
                         int iD)
                  throws IOException,
                         AutomationException
Chain a given message from the message id.

Product Availability

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

Specified by:
chainMessage in interface IGPMessageManager
Parameters:
type - A com.esri.arcgis.geodatabase.esriGPMessageType constant (in)
iD - The iD (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

chainMessage1Args

public void chainMessage1Args(int type,
                              int iD,
                              String arg1)
                       throws IOException,
                              AutomationException
Chain a given message from the message id.

Product Availability

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

Specified by:
chainMessage1Args in interface IGPMessageManager
Parameters:
type - A com.esri.arcgis.geodatabase.esriGPMessageType constant (in)
iD - The iD (in)
arg1 - The arg1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

chainMessage2Args

public void chainMessage2Args(int type,
                              int iD,
                              String arg1,
                              String arg2)
                       throws IOException,
                              AutomationException
Chain a given message from the message id.

Product Availability

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

Specified by:
chainMessage2Args in interface IGPMessageManager
Parameters:
type - A com.esri.arcgis.geodatabase.esriGPMessageType constant (in)
iD - The iD (in)
arg1 - The arg1 (in)
arg2 - The arg2 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

chainMessageText

public void chainMessageText(int type,
                             int iD,
                             String msg)
                      throws IOException,
                             AutomationException
Chain a given message from the message text.

Product Availability

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

Specified by:
chainMessageText in interface IGPMessageManager
Parameters:
type - A com.esri.arcgis.geodatabase.esriGPMessageType constant (in)
iD - The iD (in)
msg - The msg (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

checkForErrors

public void checkForErrors(long fdoError,
                           IGPMessages messages,
                           boolean keepAllErrors)
                    throws IOException,
                           AutomationException
Check for any errors in the IErrorInfo structure.

Product Availability

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

Specified by:
checkForErrors in interface IGPMessageManager
Parameters:
fdoError - An error code (in)
messages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
keepAllErrors - The keepAllErrors (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.