com.esri.arcgis.geoprocessing
Class GPEnvironmentManager

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.GPEnvironmentManager
All Implemented Interfaces:
IGeoProcessorSettings, IGPDefaultNameList, IGPEnvironmentManager, IGPVariableManager, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class GPEnvironmentManager
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGPEnvironmentManager, IGPDefaultNameList, IGeoProcessorSettings, IClone, IPersist, IPersistStream, IXMLSerialize, IGPVariableManager, Externalizable

Environment Manager.

Remarks

The GPEnvironmentManager is a collection of environments used by geoprocessing tools. It is the managing object for all geoprocessing environments and their settings. The GPEnvironmentManager object is passed to each tool during Validate() and Execute() to provide access to all current environments and settings.

Product Availability

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

Supported Platforms

Windows

See Also:
Serialized Form

Constructor Summary
GPEnvironmentManager()
          Constructs a GPEnvironmentManager using ArcGIS Engine.
GPEnvironmentManager(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPEnvironmentManager theGPEnvironmentManager = (GPEnvironmentManager) obj;
 
Method Summary
 void add(IGPVariable pVariable)
          Adds a variable.
 void addEnvironment(IGPEnvironment env)
          Adds the given geoprocessing environment to the environment manager.
 void addOutputName(String name)
          Adds the given name to the list.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 boolean checkOutputName(String name)
          Returns whether or not the given name exists within the list.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 IGPVariable find(String name)
          Finds a variable.
 IGPEnvironment findEnvironment(String name)
          Locates and returns the environment with the specified name.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 IArray getEnvironments()
          Returns the environments of the environment manager as an array.
 Object getEnvVariant(IGPEnvironment env)
          Returns the value of the given environment as a variant.
 IArray getLocalEnvironments()
          Returns an array of the environments that have been updated locally.
 IGPEnvironmentManager getParent()
          Returns the parent environment manager.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 IArray getVariables()
          Returns an array of all of the variables.
 int hashCode()
          the hashcode for this object
 boolean isAddOutputsToMap()
          Indicates whether resulting output datasets should be added to the application display.
 void isDirty()
          isDirty
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 boolean isLogHistory()
          Indicates whether or not to log the execution of geoprocessing tools.
 boolean isOverwriteOutput()
          Indicates whether output datasets should be overwritten when executing geoprocessing tools.
 boolean isShowModelBuilderPrompts()
          Indicates whether to prompt the user when connecting elements in ModelBuilder if there is more than one possible connection.
 boolean isTemporaryMapLayers()
          Indicates whether new map layers are temporary by default.
 void load(IStream pstm)
          load
 void putEnvVariant(IGPEnvironment env, Object value)
          Sets the value of the given environment to the given variant.
 void readExternal(ObjectInput in)
           
 void remove(String name)
          Removes a variable.
 void removeAll()
          Removes all variables.
 void removeAllOutputNames()
          Removes all names from the list.
 void removeEnvironment(IGPEnvironment env)
          Removes the given geoprocessing environment from the environment manager.
 void removeEnvironments()
          Removes all environments from the environment manager.
 void removeOutputName(String name)
          Removes the specified name from the list.
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setAddOutputsToMap(boolean addToMap)
          Indicates whether resulting output datasets should be added to the application display.
 void setLogHistory(boolean logHistory)
          Indicates whether or not to log the execution of geoprocessing tools.
 void setOverwriteOutput(boolean overwriteOutput)
          Indicates whether output datasets should be overwritten when executing geoprocessing tools.
 void setParentByRef(IGPEnvironmentManager parent)
          Returns the parent environment manager.
 void setPersistAll(boolean rhs1)
          Indicates whether all environments or only local environments are persisted.
 void setShowModelBuilderPrompts(boolean showPrompts)
          Indicates whether to prompt the user when connecting elements in ModelBuilder if there is more than one possible connection.
 void setTemporaryMapLayers(boolean temporaryMapLayers)
          Indicates whether new map layers are temporary by default.
 void substituteEnvironments(IArray pParams)
          Substitues the values of the given array of parameters with the current environment values.
 void writeExternal(ObjectOutput out)
           
 
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

GPEnvironmentManager

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

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

GPEnvironmentManager

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

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

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

getParent

public IGPEnvironmentManager getParent()
                                throws IOException,
                                       AutomationException
Returns the parent environment manager.

Remarks

The Parent property returns a reference to the root environment manager, i.e., ArcToolbox.

Product Availability

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

Supported Platforms

Windows

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

setParentByRef

public void setParentByRef(IGPEnvironmentManager parent)
                    throws IOException,
                           AutomationException
Returns the parent environment manager.

Product Availability

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

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

addEnvironment

public void addEnvironment(IGPEnvironment env)
                    throws IOException,
                           AutomationException
Adds the given geoprocessing environment to the environment manager.

Remarks

The AddEnvironment methods adds a given environment to the environments array.

Product Availability

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

Supported Platforms

Windows

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

removeEnvironment

public void removeEnvironment(IGPEnvironment env)
                       throws IOException,
                              AutomationException
Removes the given geoprocessing environment from the environment manager.

Product Availability

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

Supported Platforms

Windows

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

substituteEnvironments

public void substituteEnvironments(IArray pParams)
                            throws IOException,
                                   AutomationException
Substitues the values of the given array of parameters with the current environment values.

Product Availability

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

Supported Platforms

Windows

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

removeEnvironments

public void removeEnvironments()
                        throws IOException,
                               AutomationException
Removes all environments from the environment manager.

Product Availability

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

Supported Platforms

Windows

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

getEnvironments

public IArray getEnvironments()
                       throws IOException,
                              AutomationException
Returns the environments of the environment manager as an array.

Remarks

The GetEnvironments method returns all possible environments of an environment manager as an array. Use this method to access a complete environments list of a GPEnviornmentManager object.

Product Availability

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

Supported Platforms

Windows

Specified by:
getEnvironments in interface IGPEnvironmentManager
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.

getLocalEnvironments

public IArray getLocalEnvironments()
                            throws IOException,
                                   AutomationException
Returns an array of the environments that have been updated locally.

Remarks

The GetLocalEnvironments method returns the environments [as an IArray object] defined for an object such as a model process or a model.

Product Availability

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

Supported Platforms

Windows

Specified by:
getLocalEnvironments in interface IGPEnvironmentManager
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.

findEnvironment

public IGPEnvironment findEnvironment(String name)
                               throws IOException,
                                      AutomationException
Locates and returns the environment with the specified name.

Remarks

The FindEnvironment method returns the specified environment as string. Use this method to access a specific environment.

A code snippet on how to use this method is included below.

Product Availability

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

Supported Platforms

Windows

Specified by:
findEnvironment in interface IGPEnvironmentManager
Parameters:
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.

putEnvVariant

public void putEnvVariant(IGPEnvironment env,
                          Object value)
                   throws IOException,
                          AutomationException
Sets the value of the given environment to the given variant.

Product Availability

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

Supported Platforms

Windows

Specified by:
putEnvVariant in interface IGPEnvironmentManager
Parameters:
env - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironment (in)
value - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEnvVariant

public Object getEnvVariant(IGPEnvironment env)
                     throws IOException,
                            AutomationException
Returns the value of the given environment as a variant.

Product Availability

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

Supported Platforms

Windows

Specified by:
getEnvVariant in interface IGPEnvironmentManager
Parameters:
env - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironment (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPersistAll

public void setPersistAll(boolean rhs1)
                   throws IOException,
                          AutomationException
Indicates whether all environments or only local environments are persisted.

Product Availability

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

Supported Platforms

Windows

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

removeAllOutputNames

public void removeAllOutputNames()
                          throws IOException,
                                 AutomationException
Removes all names from the list.

Product Availability

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

Supported Platforms

Windows

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

addOutputName

public void addOutputName(String name)
                   throws IOException,
                          AutomationException
Adds the given name to the list.

Product Availability

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

Supported Platforms

Windows

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

removeOutputName

public void removeOutputName(String name)
                      throws IOException,
                             AutomationException
Removes the specified name from the list.

Product Availability

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

Supported Platforms

Windows

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

checkOutputName

public boolean checkOutputName(String name)
                        throws IOException,
                               AutomationException
Returns whether or not the given name exists within the list.

Product Availability

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

Supported Platforms

Windows

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

setAddOutputsToMap

public void setAddOutputsToMap(boolean addToMap)
                        throws IOException,
                               AutomationException
Indicates whether resulting output datasets should be added to the application display.

Product Availability

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

Supported Platforms

Windows

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

isAddOutputsToMap

public boolean isAddOutputsToMap()
                          throws IOException,
                                 AutomationException
Indicates whether resulting output datasets should be added to the application display.

Product Availability

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

Supported Platforms

Windows

Specified by:
isAddOutputsToMap in interface IGeoProcessorSettings
Returns:
The addToMap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOverwriteOutput

public void setOverwriteOutput(boolean overwriteOutput)
                        throws IOException,
                               AutomationException
Indicates whether output datasets should be overwritten when executing geoprocessing tools.

Remarks

When creating a custom tool that writes output data, it is necessary to check the GeoProcessor setting OberwriteOutput. A code sample is included below on how to do this.

Product Availability

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

Supported Platforms

Windows

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

isOverwriteOutput

public boolean isOverwriteOutput()
                          throws IOException,
                                 AutomationException
Indicates whether output datasets should be overwritten when executing geoprocessing tools.

Remarks

The OutputOverwrite property determines if output created by a function execution will be overwritten by subsequent function executions. A code sample to check the OutputOverwrite setting is included below.

Product Availability

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

Supported Platforms

Windows

Specified by:
isOverwriteOutput in interface IGeoProcessorSettings
Returns:
The overwriteOutput
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTemporaryMapLayers

public void setTemporaryMapLayers(boolean temporaryMapLayers)
                           throws IOException,
                                  AutomationException
Indicates whether new map layers are temporary by default.

Product Availability

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

Supported Platforms

Windows

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

isTemporaryMapLayers

public boolean isTemporaryMapLayers()
                             throws IOException,
                                    AutomationException
Indicates whether new map layers are temporary by default.

Remarks

The TemporaryMapLayer property indicates if a new map layer is by default temporary data or not.

Product Availability

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

Supported Platforms

Windows

Specified by:
isTemporaryMapLayers in interface IGeoProcessorSettings
Returns:
The temporaryMapLayers
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowModelBuilderPrompts

public void setShowModelBuilderPrompts(boolean showPrompts)
                                throws IOException,
                                       AutomationException
Indicates whether to prompt the user when connecting elements in ModelBuilder if there is more than one possible connection.

Product Availability

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

Supported Platforms

Windows

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

isShowModelBuilderPrompts

public boolean isShowModelBuilderPrompts()
                                  throws IOException,
                                         AutomationException
Indicates whether to prompt the user when connecting elements in ModelBuilder if there is more than one possible connection.

Product Availability

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

Supported Platforms

Windows

Specified by:
isShowModelBuilderPrompts in interface IGeoProcessorSettings
Returns:
The showPrompts
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLogHistory

public void setLogHistory(boolean logHistory)
                   throws IOException,
                          AutomationException
Indicates whether or not to log the execution of geoprocessing tools.

Product Availability

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

Supported Platforms

Windows

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

isLogHistory

public boolean isLogHistory()
                     throws IOException,
                            AutomationException
Indicates whether or not to log the execution of geoprocessing tools.

Remarks

Having a log of function executions can be useful. The LogHistory porperty checks if the setting is on or off.

Product Availability

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

Supported Platforms

Windows

Specified by:
isLogHistory in interface IGeoProcessorSettings
Returns:
The logHistory
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

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

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

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException
getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException
save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException
getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException
Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException
Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

add

public void add(IGPVariable pVariable)
         throws IOException,
                AutomationException
Adds a variable.

Product Availability

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

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

remove

public void remove(String name)
            throws IOException,
                   AutomationException
Removes a variable.

Product Availability

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

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

removeAll

public void removeAll()
               throws IOException,
                      AutomationException
Removes all variables.

Product Availability

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

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

find

public IGPVariable find(String name)
                 throws IOException,
                        AutomationException
Finds a variable.

Product Availability

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

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

getVariables

public IArray getVariables()
                    throws IOException,
                           AutomationException
Returns an array of all of the variables.

Product Availability

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

Specified by:
getVariables in interface IGPVariableManager
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.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException