com.esri.arcgis.geodatabase

Class IUtilityNetworkQueryDefinitionProxy

java.lang.Object

com.esri.arcgis.interop.Dispatch

com.esri.arcgis.geodatabase.IUtilityNetworkQueryDefinitionProxy

All Implemented Interfaces:

IUtilityNetworkQueryDefinition, java.io.Externalizable, java.io.Serializable

public class IUtilityNetworkQueryDefinitionProxy
extends com.esri.arcgis.interop.Dispatch
implements IUtilityNetworkQueryDefinition, java.io.Serializable

Internal use class Proxy for COM Interface 'IUtilityNetworkQueryDefinition'. Generated 9/21/2023 10:01:48 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description: 'Provides access to members that supply utility network query definition information.' 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 =

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	noncastable
static java.lang.Class	targetClass

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Fields inherited from interface com.esri.arcgis.geodatabase.IUtilityNetworkQueryDefinition

IID, IIDc8b8bcd5_0f60_4a6c_a374_e62ceea3a686

Constructor Summary

Constructors

Modifier	Constructor and Description
	IUtilityNetworkQueryDefinitionProxy() For internal use only
	IUtilityNetworkQueryDefinitionProxy(java.lang.Object obj)
protected	IUtilityNetworkQueryDefinitionProxy(java.lang.Object obj, java.lang.String iid)
	IUtilityNetworkQueryDefinitionProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
protected	IUtilityNetworkQueryDefinitionProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)

Method Summary

Modifier and Type	Method and Description
void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource) Adds a Java object to be a listener for a specific kind of event generated by the COM object.
boolean	checkIfInternalEdge(long edgeEID) Check if an edge is internal or not.
void	getAssetGroupCode(int elementType, long eID, int[] assetGroupCode) Returns the asset group code by EID.
void	getAssetTypeCode(int elementType, long eID, int[] assetTypeCode) Returns the asset type code by EID.
int	getFeatureClassUsageType(int elementType, int sourceID) Returns the utility network feature class usage type for the source.
void	getNetworkSourceID(int elementType, long eID, int[] networkSourceID) Returns the source ID by EID.
ITier	getSourceElementTier(int elementType, long eID) Returns the tier for the given source element.
void	getSubnetworkControllerByGlobalID(GUID featureGlobalID, java.lang.String[] subnetworkControllerName, int[] tierRank, java.lang.String[] featureAssetGroup, java.lang.String[] featureAssetType, int[] featureSourceID) Returns the subnetwork controller with the given subnetwork controller global ID.
void	getSubnetworkControllerByName(java.lang.String name, int[] tierRank, GUID[] featureGlobalID, java.lang.String[] featureAssetGroup, java.lang.String[] featureAssetType, int[] featureSourceID) Returns the subnetwork controller with the given subnetwork controller name.
void	getSubnetworkControllers(java.lang.Object[] featureSourceIDs, java.lang.Object[] featureGlobalIDs, java.lang.Object[] subnetworkControllerNames, java.lang.Object[] creationDates) Returns all subnetwork controllers.
void	getSubnetworkControllersBySubnetworkName(java.lang.String subnetworkName, IStringArray[] featureGlobalIDs, ILongArray[] featureTerminalIDs) Returns the feature global IDs and feature terminal IDs in the subnetworks table that correspond to the given subnetwork name and have not been deleted.
void	getSubnetworkNames(ILongLongArray subnetworkControllerEIDs, IStringArray[] subnetworkNames) Returns subnetwork names for the given subnetwork controller elements.
void	getTerminalID(long eID, int[] terminalID) Returns the terminal ID by junction EID.
void	getTerminalInfo(int networkSourceID, int assetGroupCode, int assetTypeCode, int terminalID, boolean[] isUpstreamTerminal, int[] traversabilityModel, int[] terminalCount) Returns the terminal info for the given element.
void	getTierNames(ILongLongArray subnetworkSourceEIDs, IStringArray[] tierNames) Returns tier names for the given subnetwork source elements.
boolean	isAttributeAssignedToSource(java.lang.String attributeName, int sourceID) Returns whether the attribute has been assigned to the given source.
boolean	isInCategory(int elementType, long eID, java.lang.String category) Returns whether the specified element is in the specified category.
boolean	isSupportCategory(int networkSourceID, int assetGroupCode, int assetTypeCode, java.lang.String category) Returns whether the specified source-assetGroup-assetType combination is in the specified category.
boolean	isUpstreamTerminal(int elementType, long eID) Returns whether the given element is an upstream terminal.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener) Removes a Java object as a listener to events generated by a COM object.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable

Constructor Detail

IUtilityNetworkQueryDefinitionProxy

public IUtilityNetworkQueryDefinitionProxy(java.lang.String CLSID,
                                           java.lang.String host,
                                           com.esri.arcgis.interop.AuthInfo authInfo)
                                    throws java.net.UnknownHostException,
                                           java.io.IOException

Throws:

java.net.UnknownHostException

java.io.IOException

IUtilityNetworkQueryDefinitionProxy

public IUtilityNetworkQueryDefinitionProxy()

For internal use only

IUtilityNetworkQueryDefinitionProxy

public IUtilityNetworkQueryDefinitionProxy(java.lang.Object obj)
                                    throws java.io.IOException

Throws:

java.io.IOException

IUtilityNetworkQueryDefinitionProxy

protected IUtilityNetworkQueryDefinitionProxy(java.lang.Object obj,
                                              java.lang.String iid)
                                       throws java.io.IOException

Throws:

java.io.IOException

IUtilityNetworkQueryDefinitionProxy

protected IUtilityNetworkQueryDefinitionProxy(java.lang.String CLSID,
                                              java.lang.String iid,
                                              java.lang.String host,
                                              com.esri.arcgis.interop.AuthInfo authInfo)
                                       throws java.io.IOException

Throws:

java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Description copied from class: com.esri.arcgis.interop.Dispatch

Adds a Java object to be a listener for a specific kind of event generated by the COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Parameters:

iidStr - the ID of the outgoing interface, implemented by the listener

theListener - the object to be informed of the events

theSource - the proxy class that represents the COM class that is the source of the events

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Description copied from class: com.esri.arcgis.interop.Dispatch

Removes a Java object as a listener to events generated by a COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Parameters:

iidStr - the ID of the outgoing interface, implemented by the listener

theListener - the object that no longer wishes to be informed of the events

Throws:

java.io.IOException

getNetworkSourceID

public void getNetworkSourceID(int elementType,
                               long eID,
                               int[] networkSourceID)
                        throws java.io.IOException,
                               AutomationException

Returns the source ID by EID.

Specified by:

getNetworkSourceID in interface IUtilityNetworkQueryDefinition

Parameters:

elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)

eID - Signed 64-bit int (in)

networkSourceID - The networkSourceID (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAssetGroupCode

public void getAssetGroupCode(int elementType,
                              long eID,
                              int[] assetGroupCode)
                       throws java.io.IOException,
                              AutomationException

Returns the asset group code by EID.

Specified by:

getAssetGroupCode in interface IUtilityNetworkQueryDefinition

Parameters:

elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)

eID - Signed 64-bit int (in)

assetGroupCode - The assetGroupCode (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAssetTypeCode

public void getAssetTypeCode(int elementType,
                             long eID,
                             int[] assetTypeCode)
                      throws java.io.IOException,
                             AutomationException

Returns the asset type code by EID.

Specified by:

getAssetTypeCode in interface IUtilityNetworkQueryDefinition

Parameters:

elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)

eID - Signed 64-bit int (in)

assetTypeCode - The assetTypeCode (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTerminalID

public void getTerminalID(long eID,
                          int[] terminalID)
                   throws java.io.IOException,
                          AutomationException

Returns the terminal ID by junction EID.

Specified by:

getTerminalID in interface IUtilityNetworkQueryDefinition

Parameters:

eID - Signed 64-bit int (in)

terminalID - The terminalID (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInCategory

public boolean isInCategory(int elementType,
                            long eID,
                            java.lang.String category)
                     throws java.io.IOException,
                            AutomationException

Returns whether the specified element is in the specified category.

Specified by:

isInCategory in interface IUtilityNetworkQueryDefinition

Parameters:

elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)

eID - Signed 64-bit int (in)

category - The category (in)

Returns:

The isInCategory

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportCategory

public boolean isSupportCategory(int networkSourceID,
                                 int assetGroupCode,
                                 int assetTypeCode,
                                 java.lang.String category)
                          throws java.io.IOException,
                                 AutomationException

Returns whether the specified source-assetGroup-assetType combination is in the specified category.

Specified by:

isSupportCategory in interface IUtilityNetworkQueryDefinition

Parameters:

networkSourceID - The networkSourceID (in)

assetGroupCode - The assetGroupCode (in)

assetTypeCode - The assetTypeCode (in)

category - The category (in)

Returns:

The supportsCategory

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubnetworkControllers

public void getSubnetworkControllers(java.lang.Object[] featureSourceIDs,
                                     java.lang.Object[] featureGlobalIDs,
                                     java.lang.Object[] subnetworkControllerNames,
                                     java.lang.Object[] creationDates)
                              throws java.io.IOException,
                                     AutomationException

Returns all subnetwork controllers.

Specified by:

getSubnetworkControllers in interface IUtilityNetworkQueryDefinition

Parameters:

featureSourceIDs - A Variant (out: use single element array)

featureGlobalIDs - A Variant (out: use single element array)

subnetworkControllerNames - A Variant (out: use single element array)

creationDates - A Variant (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubnetworkControllerByName

public void getSubnetworkControllerByName(java.lang.String name,
                                          int[] tierRank,
                                          GUID[] featureGlobalID,
                                          java.lang.String[] featureAssetGroup,
                                          java.lang.String[] featureAssetType,
                                          int[] featureSourceID)
                                   throws java.io.IOException,
                                          AutomationException

Returns the subnetwork controller with the given subnetwork controller name.

Specified by:

getSubnetworkControllerByName in interface IUtilityNetworkQueryDefinition

Parameters:

name - The name (in)

tierRank - The tierRank (out: use single element array)

featureGlobalID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

featureAssetGroup - The featureAssetGroup (out: use single element array)

featureAssetType - The featureAssetType (out: use single element array)

featureSourceID - The featureSourceID (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubnetworkControllerByGlobalID

public void getSubnetworkControllerByGlobalID(GUID featureGlobalID,
                                              java.lang.String[] subnetworkControllerName,
                                              int[] tierRank,
                                              java.lang.String[] featureAssetGroup,
                                              java.lang.String[] featureAssetType,
                                              int[] featureSourceID)
                                       throws java.io.IOException,
                                              AutomationException

Returns the subnetwork controller with the given subnetwork controller global ID.

Specified by:

getSubnetworkControllerByGlobalID in interface IUtilityNetworkQueryDefinition

Parameters:

featureGlobalID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

subnetworkControllerName - The subnetworkControllerName (out: use single element array)

tierRank - The tierRank (out: use single element array)

featureAssetGroup - The featureAssetGroup (out: use single element array)

featureAssetType - The featureAssetType (out: use single element array)

featureSourceID - The featureSourceID (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubnetworkControllersBySubnetworkName

public void getSubnetworkControllersBySubnetworkName(java.lang.String subnetworkName,
                                                     IStringArray[] featureGlobalIDs,
                                                     ILongArray[] featureTerminalIDs)
                                              throws java.io.IOException,
                                                     AutomationException

Returns the feature global IDs and feature terminal IDs in the subnetworks table that correspond to the given subnetwork name and have not been deleted.

Specified by:

getSubnetworkControllersBySubnetworkName in interface IUtilityNetworkQueryDefinition

Parameters:

subnetworkName - The subnetworkName (in)

featureGlobalIDs - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

featureTerminalIDs - A reference to a com.esri.arcgis.system.ILongArray (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceElementTier

public ITier getSourceElementTier(int elementType,
                                  long eID)
                           throws java.io.IOException,
                                  AutomationException

Returns the tier for the given source element.

Specified by:

getSourceElementTier in interface IUtilityNetworkQueryDefinition

Parameters:

elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)

eID - Signed 64-bit int (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.ITier

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureClassUsageType

public int getFeatureClassUsageType(int elementType,
                                    int sourceID)
                             throws java.io.IOException,
                                    AutomationException

Returns the utility network feature class usage type for the source.

Specified by:

getFeatureClassUsageType in interface IUtilityNetworkQueryDefinition

Parameters:

elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)

sourceID - The sourceID (in)

Returns:

A com.esri.arcgis.geodatabase.esriUtilityNetworkFeatureClassUsageType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAttributeAssignedToSource

public boolean isAttributeAssignedToSource(java.lang.String attributeName,
                                           int sourceID)
                                    throws java.io.IOException,
                                           AutomationException

Returns whether the attribute has been assigned to the given source.

Specified by:

isAttributeAssignedToSource in interface IUtilityNetworkQueryDefinition

Parameters:

attributeName - The attributeName (in)

sourceID - The sourceID (in)

Returns:

The isAssigned

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTierNames

public void getTierNames(ILongLongArray subnetworkSourceEIDs,
                         IStringArray[] tierNames)
                  throws java.io.IOException,
                         AutomationException

Returns tier names for the given subnetwork source elements.

Specified by:

getTierNames in interface IUtilityNetworkQueryDefinition

Parameters:

subnetworkSourceEIDs - A reference to a com.esri.arcgis.system.ILongLongArray (in)

tierNames - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubnetworkNames

public void getSubnetworkNames(ILongLongArray subnetworkControllerEIDs,
                               IStringArray[] subnetworkNames)
                        throws java.io.IOException,
                               AutomationException

Returns subnetwork names for the given subnetwork controller elements.

Specified by:

getSubnetworkNames in interface IUtilityNetworkQueryDefinition

Parameters:

subnetworkControllerEIDs - A reference to a com.esri.arcgis.system.ILongLongArray (in)

subnetworkNames - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUpstreamTerminal

public boolean isUpstreamTerminal(int elementType,
                                  long eID)
                           throws java.io.IOException,
                                  AutomationException

Returns whether the given element is an upstream terminal.

Specified by:

isUpstreamTerminal in interface IUtilityNetworkQueryDefinition

Parameters:

elementType - A com.esri.arcgis.geodatabase.esriElementType constant (in)

eID - Signed 64-bit int (in)

Returns:

The isUpstreamTerminal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTerminalInfo

public void getTerminalInfo(int networkSourceID,
                            int assetGroupCode,
                            int assetTypeCode,
                            int terminalID,
                            boolean[] isUpstreamTerminal,
                            int[] traversabilityModel,
                            int[] terminalCount)
                     throws java.io.IOException,
                            AutomationException

Returns the terminal info for the given element.

Specified by:

getTerminalInfo in interface IUtilityNetworkQueryDefinition

Parameters:

networkSourceID - The networkSourceID (in)

assetGroupCode - The assetGroupCode (in)

assetTypeCode - The assetTypeCode (in)

terminalID - The terminalID (in)

isUpstreamTerminal - The isUpstreamTerminal (out: use single element array)

traversabilityModel - A com.esri.arcgis.geodatabase.esriUtilityNetworkTraversabilityModel constant (out: use single element array)

terminalCount - The terminalCount (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

checkIfInternalEdge

public boolean checkIfInternalEdge(long edgeEID)
                            throws java.io.IOException,
                                   AutomationException

Check if an edge is internal or not.

Specified by:

checkIfInternalEdge in interface IUtilityNetworkQueryDefinition

Parameters:

edgeEID - Signed 64-bit int (in)

Returns:

The isInternalEdge

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.