com.esri.arcgis.geodatabase

Interface IUtilityNetworkQueryDefinition

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IUtilityNetworkQueryDefinitionProxy

public interface IUtilityNetworkQueryDefinition
extends java.io.Serializable

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 =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IIDc8b8bcd5_0f60_4a6c_a374_e62ceea3a686
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
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.

Field Detail

IIDc8b8bcd5_0f60_4a6c_a374_e62ceea3a686

static final int IIDc8b8bcd5_0f60_4a6c_a374_e62ceea3a686

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

getNetworkSourceID

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

Returns the source ID by EID.

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

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

Returns the asset group code by EID.

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

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

Returns the asset type code by EID.

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

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

Returns the terminal ID by junction EID.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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

Returns the tier for the given source element.

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

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

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

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

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

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

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

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

Returns tier names for the given subnetwork source elements.

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

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

Returns subnetwork names for the given subnetwork controller elements.

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

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

Returns whether the given element is an upstream terminal.

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

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.

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

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

Check if an edge is internal or not.

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.