com.esri.arcgis.networkanalyst
Interface INAAgent

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

INAAgentProxy, NACompactStreetDirectionsAgent, NAStreetDirectionsAgent

public interface INAAgent
extends java.io.Serializable

COM Interface 'INAAgent'. Generated 3/19/2015 1:20:59 PM from 'C:\ArcGIS\COM\esriNetworkAnalyst.olb'

Description: 'Provides access to properties/methods common to all network analysis agents.' 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	IIDa6af9d1f_a27c_4df8_b989_8844173c776f
static int	xxDummy Deprecated. Internal use only

Method Summary

boolean	applies(IDENetworkDataset network, INAContextHelper contextHelper) Indicates if the agent is appropriate to use with the given network dataset.
java.lang.String	getName() The name of the agent.
void	initialize(IDENetworkDataset network, INAContextHelper contextHelper) Get the agent ready for action.
void	onContextUpdated() Called when the context is updated.
void	onResultUpdated() Called when a result is updated.

Field Detail

IIDa6af9d1f_a27c_4df8_b989_8844173c776f

static final int IIDa6af9d1f_a27c_4df8_b989_8844173c776f

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

The name of the agent.

Returns:

The agentName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

applies

boolean applies(IDENetworkDataset network,
                INAContextHelper contextHelper)
                throws java.io.IOException,
                       AutomationException

Indicates if the agent is appropriate to use with the given network dataset.

Parameters:

network - A reference to a com.esri.arcgis.geodatabase.IDENetworkDataset (in)

contextHelper - A reference to a com.esri.arcgis.networkanalyst.INAContextHelper (in)

Returns:

The agentApplies

Throws:

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

AutomationException - If the ArcObject component throws an exception.

initialize

void initialize(IDENetworkDataset network,
                INAContextHelper contextHelper)
                throws java.io.IOException,
                       AutomationException

Get the agent ready for action.

Parameters:

network - A reference to a com.esri.arcgis.geodatabase.IDENetworkDataset (in)

contextHelper - A reference to a com.esri.arcgis.networkanalyst.INAContextHelper (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onResultUpdated

void onResultUpdated()
                     throws java.io.IOException,
                            AutomationException

Called when a result is updated.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onContextUpdated

void onContextUpdated()
                      throws java.io.IOException,
                             AutomationException

Called when the context is updated.

Throws:

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

AutomationException - If the ArcObject component throws an exception.