com.esri.arcgis.networkanalyst
Interface INAServerClosestFacilityParams

All Superinterfaces:

INAServerSolverParams, Serializable

All Known Subinterfaces:

INAServerClosestFacilityParams2, INAServerClosestFacilityParams3

All Known Implementing Classes:

NAServerClosestFacilityParams

public interface INAServerClosestFacilityParams
extends INAServerSolverParams, Serializable

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.

Superseded By

INAServerClosestFacilityParams2

Remarks

At version 10.1, ArcGIS for Server no longer supports performing network analysis via local connections using the GISServer and GISClient APIs. Use the SOAP or REST API instead.

INAServerClosestFacilityParams has been superseded by INAServerClosestFacilityParams3.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

INAServerLocations	getBarriers() RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.
String	getDirectionsLanguage() Language to use when computing directions.
int	getDirectionsLengthUnits() Length units to use when computing directions.
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(String directionsLanguage) Language to use when computing directions.
void	setDirectionsLengthUnits(int directionsLengthUnits) Length units to use when computing directions.
void	setDirectionsTimeAttributeName(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

Method Detail

setFacilitiesByRef

void setFacilitiesByRef(INAServerLocations facilities)
                        throws IOException,
                               AutomationException

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

Remarks

Facilities specifies an instance of NAServerLocations class to take into account when solving a Closest Facility problem.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFacilities

INAServerLocations getFacilities()
                                 throws IOException,
                                        AutomationException

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

Remarks

Facilities specifies an instance of NAServerLocations class to take into account when solving a Closest Facility problem.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIncidentsByRef

void setIncidentsByRef(INAServerLocations incidents)
                       throws IOException,
                              AutomationException

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

Remarks

Incidents specifies an instance of NAServerLocations class to take into account when solving a Closest Facility problem.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIncidents

INAServerLocations getIncidents()
                                throws IOException,
                                       AutomationException

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

Remarks

Incidents specifiesan instance of NAServerLocations class to take into account when solving a Closest Facility problem.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBarriersByRef

void setBarriersByRef(INAServerLocations barriers)
                      throws IOException,
                             AutomationException

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

Remarks

Barriers specifies an instance of NAServerLocations class to use in order to restrict or alter the impedance of network elements.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBarriers

INAServerLocations getBarriers()
                               throws IOException,
                                      AutomationException

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

Remarks

Barriers specifies an instance of NAServerLocations class to use in order to restrict or alter the impedance of network elements.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnCFRouteGeometries

void setReturnCFRouteGeometries(boolean returnCFRouteGeometries)
                                throws IOException,
                                       AutomationException

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

Remarks

ReturnCFRouteGeometries specifies if the Polylines for the resulting CFRoute features are returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

returnCFRouteGeometries - The returnCFRouteGeometries (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnCFRouteGeometries

boolean isReturnCFRouteGeometries()
                                  throws IOException,
                                         AutomationException

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

Remarks

ReturnCFRouteGeometries specifies if the Polylines for the resulting CFRoute features are returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The returnCFRouteGeometries

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnCFRoutes

void setReturnCFRoutes(boolean returnCFRoutes)
                       throws IOException,
                              AutomationException

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

Remarks

ReturnCFRoutes specifies if the resulting CFRoute features are returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

returnCFRoutes - The returnCFRoutes (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnCFRoutes

boolean isReturnCFRoutes()
                         throws IOException,
                                AutomationException

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

Remarks

ReturnCFRoutes specifies if the resulting CFRoute features are returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The returnCFRoutes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnFacilities

void setReturnFacilities(boolean returnFacilities)
                         throws IOException,
                                AutomationException

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

Remarks

ReturnFacilites specifies if the resulting Facility features are returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

returnFacilities - The returnFacilities (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnFacilities

boolean isReturnFacilities()
                           throws IOException,
                                  AutomationException

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

Remarks

ReturnFacilites specifies if the resulting Facility features are returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The returnFacilities

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnIncidents

void setReturnIncidents(boolean returnIncidents)
                        throws IOException,
                               AutomationException

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

Remarks

ReturnIncidents specifies if the resulting Incident features are returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

returnIncidents - The returnIncidents (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnIncidents

boolean isReturnIncidents()
                          throws IOException,
                                 AutomationException

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

Remarks

ReturnIncidents specifies if the resulting Incident features are returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The returnIncidents

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnBarriers

void setReturnBarriers(boolean returnBarriers)
                       throws IOException,
                              AutomationException

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

Remarks

ReturnBarriers specifies if the Barriers are returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

returnBarriers - The returnBarriers (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnBarriers

boolean isReturnBarriers()
                         throws IOException,
                                AutomationException

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

Remarks

ReturnBarriers specifies if the Barriers are returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The returnBarriers

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnDirections

void setReturnDirections(boolean returnDirections)
                         throws IOException,
                                AutomationException

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

Remarks

ReturnDirections specifies if directions are calculated during solve and returned in INAServerClosestFacilityResults.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

returnDirections - The returnDirections (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnDirections

boolean isReturnDirections()
                           throws IOException,
                                  AutomationException

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

Remarks

ReturnDirections specifies if directions are calculated during solve and returned in INAServerClosestFacilityResults.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The returnDirections

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirectionsLanguage

void setDirectionsLanguage(String directionsLanguage)
                           throws IOException,
                                  AutomationException

Language to use when computing directions.

Remarks

DirectionsLanguage specifies the language used when generating directions.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

directionsLanguage - The directionsLanguage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionsLanguage

String getDirectionsLanguage()
                             throws IOException,
                                    AutomationException

Language to use when computing directions.

Remarks

DirectionsLanguage specifies the language used when generating directions.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The directionsLanguage

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirectionsLengthUnits

void setDirectionsLengthUnits(int directionsLengthUnits)
                              throws IOException,
                                     AutomationException

Length units to use when computing directions.

Remarks

DirectionsLengthUnits specifies the length units of the directions in esriNetworkAttributeUnits.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionsLengthUnits

int getDirectionsLengthUnits()
                             throws IOException,
                                    AutomationException

Length units to use when computing directions.

Remarks

DirectionsLengthUnits specifies the length units of the directions in esriNetworkAttributeUnits.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A com.esri.arcgis.geodatabase.esriNetworkAttributeUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirectionsTimeAttributeName

void setDirectionsTimeAttributeName(String directionsTimeAttributeName)
                                    throws IOException,
                                           AutomationException

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

Remarks

DirectionsTimeAttributeName specifies the time cost attribute used when generating directions.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

directionsTimeAttributeName - The directionsTimeAttributeName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionsTimeAttributeName

String getDirectionsTimeAttributeName()
                                      throws IOException,
                                             AutomationException

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

Remarks

DirectionsTimeAttributeName specifies the time cost attribute used when generating directions.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The directionsTimeAttributeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.