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

com.esri.arcgis.geoprocessing
Interface IMdModel

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
IMdModelProxy, MdModel
public interface IMdModel
extends java.io.Serializable

COM Interface 'IMdModel'. Generated 3/19/2015 1:20:58 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'

Description: 'Provides access to properties/methods of a model.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IIDdfaf9812_6b7b_4ac2_ad6b_bbdef1ede0e6
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void addElement(IMdElement element)
          Adds the given element to the model.
 void addElements(IArray elements)
          Adds the collection of elements to the model.
 boolean canAddElement(IMdElement pElement)
          Returns whether or not the given model element can be added to the model.
 java.lang.String createUniqueElementName(java.lang.String name)
          Generates a new unique name that may be used for adding a new model element to the model.
 void deleteElement(IMdElement element)
          Removes the given element from the model.
 void disconnectElements(IMdElement pFromElement, IMdElement pToElement, int connectionType)
          Removes the connection/dependency between two model elements.
 void empty()
          Removes all model elements from the model.
 void execute(ITrackCancel trackCancel, boolean reset, IGPEnvironmentManager pEnvMgr, IGPMessages messages, boolean stopOnFirstFailure)
          Executes all the processes in the model.
 void executeProcess(IMdProcess pMdProcess, ITrackCancel trackCancel, boolean reset, IGPEnvironmentManager pEnvMgr, IGPMessages messages, boolean stopOnFirstFailure)
          Executes a single process in the model.
 IEnumMdElement findDependents(IMdElement pMdElement, int direction, int connectionType)
          Returns all the model elements dependent on the given model element in the given direction of the given connection type.
 IMdElement getElement(java.lang.String name)
          Returns the model element with the given name.
 IMdElement getElementByID(int identifier)
          Returns the model element with the given identifier.
 IEnumMdElement getElements()
          Returns all of the model elements in the model.
 IGPEnvironmentManager getEnvironmentManager()
          The set of overriding environment values used when validating/executing the model.
 java.lang.String getName()
          Name of the model.
 IEnumMdProcess getProcesses()
          Returns all of the processes in the model.
 IEnumMdVariable getVariables()
          Returns all of the variables in the model.
 boolean isLicensed()
          Returns whether or not all the processes in the model are licensed.
 boolean isValid()
          Returns whether or not all the model elements in the model are valid.
 void mergeElements(IEnumMdElement pElements)
          Merges the given enumeration of model elements, commonly from another model, into the current model.
 void setEnvironmentManagerByRef(IGPEnvironmentManager ppEnvMgr)
          The set of overriding environment values used when validating/executing the model.
 void setName(java.lang.String name)
          Name of the model.
 IEnumMdElement sortElements()
          Returns all the model elements in the model in sorted order.
 IEnumMdElement traceDependents(IMdElement pMdElement, int direction, int depth)
          Returns all the model elements dependent on the given model element in the given direction.
 IGPMessages validate(boolean reset, IGPEnvironmentManager pEnvMgr)
          Validates all model elements in the model.
 boolean verifyUniqueElementName(java.lang.String name)
          Returns whether or not the model already contains a model element by the given name.
 

Field Detail

IIDdfaf9812_6b7b_4ac2_ad6b_bbdef1ede0e6

static final int IIDdfaf9812_6b7b_4ac2_ad6b_bbdef1ede0e6
See Also:
Constant Field Values

xxDummy

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

IID

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

getName

java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
Name of the model.

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

setName

void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException
Name of the model.

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

addElement

void addElement(IMdElement element)
                throws java.io.IOException,
                       AutomationException
Adds the given element to the model.

Parameters:
element - A reference to a com.esri.arcgis.geoprocessing.IMdElement (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addElements

void addElements(IArray elements)
                 throws java.io.IOException,
                        AutomationException
Adds the collection of elements to the model.

Parameters:
elements - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getElement

IMdElement getElement(java.lang.String name)
                      throws java.io.IOException,
                             AutomationException
Returns the model element with the given name.

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

getElementByID

IMdElement getElementByID(int identifier)
                          throws java.io.IOException,
                                 AutomationException
Returns the model element with the given identifier.

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

getElements

IEnumMdElement getElements()
                           throws java.io.IOException,
                                  AutomationException
Returns all of the model elements in the model.

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

getVariables

IEnumMdVariable getVariables()
                             throws java.io.IOException,
                                    AutomationException
Returns all of the variables in the model.

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

getProcesses

IEnumMdProcess getProcesses()
                            throws java.io.IOException,
                                   AutomationException
Returns all of the processes in the model.

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

deleteElement

void deleteElement(IMdElement element)
                   throws java.io.IOException,
                          AutomationException
Removes the given element from the model.

Parameters:
element - A reference to a com.esri.arcgis.geoprocessing.IMdElement (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

empty

void empty()
           throws java.io.IOException,
                  AutomationException
Removes all model elements from the model.

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

validate

IGPMessages validate(boolean reset,
                     IGPEnvironmentManager pEnvMgr)
                     throws java.io.IOException,
                            AutomationException
Validates all model elements in the model.

Parameters:
reset - The reset (in)
pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPMessages
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

execute

void execute(ITrackCancel trackCancel,
             boolean reset,
             IGPEnvironmentManager pEnvMgr,
             IGPMessages messages,
             boolean stopOnFirstFailure)
             throws java.io.IOException,
                    AutomationException
Executes all the processes in the model.

Parameters:
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
reset - The reset (in)
pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
messages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
stopOnFirstFailure - The stopOnFirstFailure (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

executeProcess

void executeProcess(IMdProcess pMdProcess,
                    ITrackCancel trackCancel,
                    boolean reset,
                    IGPEnvironmentManager pEnvMgr,
                    IGPMessages messages,
                    boolean stopOnFirstFailure)
                    throws java.io.IOException,
                           AutomationException
Executes a single process in the model.

Parameters:
pMdProcess - A reference to a com.esri.arcgis.geoprocessing.IMdProcess (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
reset - The reset (in)
pEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
messages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)
stopOnFirstFailure - The stopOnFirstFailure (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

sortElements

IEnumMdElement sortElements()
                            throws java.io.IOException,
                                   AutomationException
Returns all the model elements in the model in sorted order.

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

traceDependents

IEnumMdElement traceDependents(IMdElement pMdElement,
                               int direction,
                               int depth)
                               throws java.io.IOException,
                                      AutomationException
Returns all the model elements dependent on the given model element in the given direction.

Parameters:
pMdElement - A reference to a com.esri.arcgis.geoprocessing.IMdElement (in)
direction - A com.esri.arcgis.geoprocessing.esriMdDirection constant (in)
depth - The depth (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IEnumMdElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findDependents

IEnumMdElement findDependents(IMdElement pMdElement,
                              int direction,
                              int connectionType)
                              throws java.io.IOException,
                                     AutomationException
Returns all the model elements dependent on the given model element in the given direction of the given connection type.

Parameters:
pMdElement - A reference to a com.esri.arcgis.geoprocessing.IMdElement (in)
direction - A com.esri.arcgis.geoprocessing.esriMdDirection constant (in)
connectionType - A com.esri.arcgis.geoprocessing.esriMdConnectionType constant (in)
Returns:
A reference to a com.esri.arcgis.geoprocessing.IEnumMdElement
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

mergeElements

void mergeElements(IEnumMdElement pElements)
                   throws java.io.IOException,
                          AutomationException
Merges the given enumeration of model elements, commonly from another model, into the current model.

Parameters:
pElements - A reference to a com.esri.arcgis.geoprocessing.IEnumMdElement (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

verifyUniqueElementName

boolean verifyUniqueElementName(java.lang.String name)
                                throws java.io.IOException,
                                       AutomationException
Returns whether or not the model already contains a model element by the given name.

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

canAddElement

boolean canAddElement(IMdElement pElement)
                      throws java.io.IOException,
                             AutomationException
Returns whether or not the given model element can be added to the model.

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

getEnvironmentManager

IGPEnvironmentManager getEnvironmentManager()
                                            throws java.io.IOException,
                                                   AutomationException
The set of overriding environment values used when validating/executing the model.

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

setEnvironmentManagerByRef

void setEnvironmentManagerByRef(IGPEnvironmentManager ppEnvMgr)
                                throws java.io.IOException,
                                       AutomationException
The set of overriding environment values used when validating/executing the model.

Parameters:
ppEnvMgr - A reference to a com.esri.arcgis.geoprocessing.IGPEnvironmentManager (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isValid

boolean isValid()
                throws java.io.IOException,
                       AutomationException
Returns whether or not all the model elements in the model are valid.

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

isLicensed

boolean isLicensed()
                   throws java.io.IOException,
                          AutomationException
Returns whether or not all the processes in the model are licensed.

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

disconnectElements

void disconnectElements(IMdElement pFromElement,
                        IMdElement pToElement,
                        int connectionType)
                        throws java.io.IOException,
                               AutomationException
Removes the connection/dependency between two model elements.

Parameters:
pFromElement - A reference to a com.esri.arcgis.geoprocessing.IMdElement (in)
pToElement - A reference to a com.esri.arcgis.geoprocessing.IMdElement (in)
connectionType - A com.esri.arcgis.geoprocessing.esriMdConnectionType constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createUniqueElementName

java.lang.String createUniqueElementName(java.lang.String name)
                                         throws java.io.IOException,
                                                AutomationException
Generates a new unique name that may be used for adding a new model element to the model.

Parameters:
name - The name (in)
Returns:
The pName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD