com.esri.arcgis.networkanalyst
Interface INAServerClosestFacilityParams

All Superinterfaces:

INAServerSolverParams, java.io.Serializable

All Known Subinterfaces:

INAServerClosestFacilityParams2, INAServerClosestFacilityParams3

All Known Implementing Classes:

INAServerClosestFacilityParams2Proxy, INAServerClosestFacilityParams3Proxy, INAServerClosestFacilityParamsProxy, NAServerClosestFacilityParams

public interface INAServerClosestFacilityParams
extends INAServerSolverParams, java.io.Serializable

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

Description: 'Deprecated as of 10.0. Provides access to properties that specify the closest facility solver settings and return parameters used during network analysis with NAServer.' 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	IIDb54ed486_f9f7_4109_bb9d_472feca27711
static int	xxDummy Deprecated. Internal use only

Fields inherited from interface com.esri.arcgis.networkanalyst.INAServerSolverParams

IID40635a1f_4c95_4f57_a220_c683941715e5

Method Summary

INAServerLocations	getBarriers() RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.
java.lang.String	getDirectionsLanguage() Language to use when computing directions.
int	getDirectionsLengthUnits() Length units to use when computing directions.
java.lang.String	getDirectionsTimeAttributeName() Name of network attribute to use for the drive time when computing directions.
INAServerLocations	getFacilities() RecordSet or array of PropertySets representing Facilities loaded as network locations during analysis.
INAServerLocations	getIncidents() RecordSet or array of PropertySets representing Incidents loaded as network locations during analysis.
boolean	isReturnBarriers() Indicates if the output barriers recordset should be returned with the analysis results.
boolean	isReturnCFRouteGeometries() Indicates if the CFRoute geometries should be generated and returned with the analysis results.
boolean	isReturnCFRoutes() Indicates if the output CFRoutes recordset should be returned with the analysis results.
boolean	isReturnDirections() Indicates if directions should be generated and returned with the analysis results.
boolean	isReturnFacilities() Indicates if the output facilities recordset should be returned with the analysis results.
boolean	isReturnIncidents() Indicates if the output incidents recordset should be returned with the analysis results.
void	setBarriersByRef(INAServerLocations barriers) RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.
void	setDirectionsLanguage(java.lang.String directionsLanguage) Language to use when computing directions.
void	setDirectionsLengthUnits(int directionsLengthUnits) Length units to use when computing directions.
void	setDirectionsTimeAttributeName(java.lang.String directionsTimeAttributeName) Name of network attribute to use for the drive time when computing directions.
void	setFacilitiesByRef(INAServerLocations facilities) RecordSet or array of PropertySets representing Facilities loaded as network locations during analysis.
void	setIncidentsByRef(INAServerLocations incidents) RecordSet or array of PropertySets representing Incidents loaded as network locations during analysis.
void	setReturnBarriers(boolean returnBarriers) Indicates if the output barriers recordset should be returned with the analysis results.
void	setReturnCFRouteGeometries(boolean returnCFRouteGeometries) Indicates if the CFRoute geometries should be generated and returned with the analysis results.
void	setReturnCFRoutes(boolean returnCFRoutes) Indicates if the output CFRoutes recordset should be returned with the analysis results.
void	setReturnDirections(boolean returnDirections) Indicates if directions should be generated and returned with the analysis results.
void	setReturnFacilities(boolean returnFacilities) Indicates if the output facilities recordset should be returned with the analysis results.
void	setReturnIncidents(boolean returnIncidents) Indicates if the output incidents recordset should be returned with the analysis results.

Methods inherited from interface com.esri.arcgis.networkanalyst.INAServerSolverParams

getImageDescription, getMapDescription, getMaxSnapTolerance, getNAClassCandidateFieldMaps, getNALayerName, getOutputSpatialReference, getSnapTolerance, getSnapToleranceUnits, isReturnMap, setImageDescriptionByRef, setMapDescriptionByRef, setMaxSnapTolerance, setNAClassCandidateFieldMaps, setNALayerName, setOutputSpatialReferenceByRef, setReturnMap, setSnapTolerance, setSnapToleranceUnits

Field Detail

IIDb54ed486_f9f7_4109_bb9d_472feca27711

static final int IIDb54ed486_f9f7_4109_bb9d_472feca27711

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

setFacilitiesByRef

void setFacilitiesByRef(INAServerLocations facilities)
                        throws java.io.IOException,
                               AutomationException

RecordSet or array of PropertySets representing Facilities loaded as network locations during analysis.

Parameters:

facilities - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFacilities

INAServerLocations getFacilities()
                                 throws java.io.IOException,
                                        AutomationException

RecordSet or array of PropertySets representing Facilities loaded as network locations during analysis.

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAServerLocations

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIncidentsByRef

void setIncidentsByRef(INAServerLocations incidents)
                       throws java.io.IOException,
                              AutomationException

RecordSet or array of PropertySets representing Incidents loaded as network locations during analysis.

Parameters:

incidents - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getIncidents

INAServerLocations getIncidents()
                                throws java.io.IOException,
                                       AutomationException

RecordSet or array of PropertySets representing Incidents loaded as network locations during analysis.

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAServerLocations

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBarriersByRef

void setBarriersByRef(INAServerLocations barriers)
                      throws java.io.IOException,
                             AutomationException

RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.

Parameters:

barriers - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBarriers

INAServerLocations getBarriers()
                               throws java.io.IOException,
                                      AutomationException

RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAServerLocations

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReturnCFRouteGeometries

void setReturnCFRouteGeometries(boolean returnCFRouteGeometries)
                                throws java.io.IOException,
                                       AutomationException

Indicates if the CFRoute geometries should be generated and returned with the analysis results.

Parameters:

returnCFRouteGeometries - The returnCFRouteGeometries (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isReturnCFRouteGeometries

boolean isReturnCFRouteGeometries()
                                  throws java.io.IOException,
                                         AutomationException

Indicates if the CFRoute geometries should be generated and returned with the analysis results.

Returns:

The returnCFRouteGeometries

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReturnCFRoutes

void setReturnCFRoutes(boolean returnCFRoutes)
                       throws java.io.IOException,
                              AutomationException

Indicates if the output CFRoutes recordset should be returned with the analysis results.

Parameters:

returnCFRoutes - The returnCFRoutes (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isReturnCFRoutes

boolean isReturnCFRoutes()
                         throws java.io.IOException,
                                AutomationException

Indicates if the output CFRoutes recordset should be returned with the analysis results.

Returns:

The returnCFRoutes

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReturnFacilities

void setReturnFacilities(boolean returnFacilities)
                         throws java.io.IOException,
                                AutomationException

Indicates if the output facilities recordset should be returned with the analysis results.

Parameters:

returnFacilities - The returnFacilities (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isReturnFacilities

boolean isReturnFacilities()
                           throws java.io.IOException,
                                  AutomationException

Indicates if the output facilities recordset should be returned with the analysis results.

Returns:

The returnFacilities

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReturnIncidents

void setReturnIncidents(boolean returnIncidents)
                        throws java.io.IOException,
                               AutomationException

Indicates if the output incidents recordset should be returned with the analysis results.

Parameters:

returnIncidents - The returnIncidents (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isReturnIncidents

boolean isReturnIncidents()
                          throws java.io.IOException,
                                 AutomationException

Indicates if the output incidents recordset should be returned with the analysis results.

Returns:

The returnIncidents

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReturnBarriers

void setReturnBarriers(boolean returnBarriers)
                       throws java.io.IOException,
                              AutomationException

Indicates if the output barriers recordset should be returned with the analysis results.

Parameters:

returnBarriers - The returnBarriers (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isReturnBarriers

boolean isReturnBarriers()
                         throws java.io.IOException,
                                AutomationException

Indicates if the output barriers recordset should be returned with the analysis results.

Returns:

The returnBarriers

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReturnDirections

void setReturnDirections(boolean returnDirections)
                         throws java.io.IOException,
                                AutomationException

Indicates if directions should be generated and returned with the analysis results.

Parameters:

returnDirections - The returnDirections (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isReturnDirections

boolean isReturnDirections()
                           throws java.io.IOException,
                                  AutomationException

Indicates if directions should be generated and returned with the analysis results.

Returns:

The returnDirections

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDirectionsLanguage

void setDirectionsLanguage(java.lang.String directionsLanguage)
                           throws java.io.IOException,
                                  AutomationException

Language to use when computing directions.

Parameters:

directionsLanguage - The directionsLanguage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDirectionsLanguage

java.lang.String getDirectionsLanguage()
                                       throws java.io.IOException,
                                              AutomationException

Language to use when computing directions.

Returns:

The directionsLanguage

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDirectionsLengthUnits

void setDirectionsLengthUnits(int directionsLengthUnits)
                              throws java.io.IOException,
                                     AutomationException

Length units to use when computing directions.

Parameters:

directionsLengthUnits - A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDirectionsLengthUnits

int getDirectionsLengthUnits()
                             throws java.io.IOException,
                                    AutomationException

Length units to use when computing directions.

Returns:

A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDirectionsTimeAttributeName

void setDirectionsTimeAttributeName(java.lang.String directionsTimeAttributeName)
                                    throws java.io.IOException,
                                           AutomationException

Name of network attribute to use for the drive time when computing directions.

Parameters:

directionsTimeAttributeName - The directionsTimeAttributeName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDirectionsTimeAttributeName

java.lang.String getDirectionsTimeAttributeName()
                                                throws java.io.IOException,
                                                       AutomationException

Name of network attribute to use for the drive time when computing directions.

Returns:

The directionsTimeAttributeName

Throws:

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

AutomationException - If the ArcObject component throws an exception.