com.esri.arcgis.networkanalyst
Interface INAServerClosestFacilityParams3

All Superinterfaces:
INAServerClosestFacilityParams, INAServerClosestFacilityParams2, INAServerSolverParams, java.io.Serializable
All Known Implementing Classes:
INAServerClosestFacilityParams3Proxy, NAServerClosestFacilityParams

public interface INAServerClosestFacilityParams3
extends INAServerClosestFacilityParams2, java.io.Serializable

COM Interface 'INAServerClosestFacilityParams3'. 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 route 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 IID7abe0b88_8fb3_4414_b9f8_60bee554f17a
           
static int xxDummy
          Deprecated. Internal use only
 
Fields inherited from interface com.esri.arcgis.networkanalyst.INAServerClosestFacilityParams2
IID9738c728_dbdc_46cb_9cc0_184b1ef5ff1c
 
Fields inherited from interface com.esri.arcgis.networkanalyst.INAServerClosestFacilityParams
IIDb54ed486_f9f7_4109_bb9d_472feca27711
 
Fields inherited from interface com.esri.arcgis.networkanalyst.INAServerSolverParams
IID40635a1f_4c95_4f57_a220_c683941715e5
 
Method Summary
 int getDirectionsOutputType()
          Type of directions to generate.
 java.lang.String getDirectionsStyleName()
          Name of the directions style to use when generating directions.
 INAServerLocations getPolygonBarriers()
          RecordSet or array of PropertySets representing polygon Barriers loaded as network locations during analysis.
 INAServerLocations getPolylineBarriers()
          RecordSet or array of PropertySets representing polyline Barriers loaded as network locations during analysis.
 boolean isReturnPolygonBarriers()
          Indicates if the output polygon barriers recordset should be returned with the analysis results.
 boolean isReturnPolylineBarriers()
          Indicates if the output polyline barriers recordset should be returned with the analysis results.
 void setDirectionsOutputType(int directionsOutputType)
          Type of directions to generate.
 void setDirectionsStyleName(java.lang.String directionsStyleName)
          Name of the directions style to use when generating directions.
 void setPolygonBarriersByRef(INAServerLocations barriers)
          RecordSet or array of PropertySets representing polygon Barriers loaded as network locations during analysis.
 void setPolylineBarriersByRef(INAServerLocations barriers)
          RecordSet or array of PropertySets representing polyline Barriers loaded as network locations during analysis.
 void setReturnPolygonBarriers(boolean returnBarriers)
          Indicates if the output polygon barriers recordset should be returned with the analysis results.
 void setReturnPolylineBarriers(boolean returnBarriers)
          Indicates if the output polyline barriers recordset should be returned with the analysis results.
 
Methods inherited from interface com.esri.arcgis.networkanalyst.INAServerClosestFacilityParams2
isReturnCompactDirections, setReturnCompactDirections
 
Methods inherited from interface com.esri.arcgis.networkanalyst.INAServerClosestFacilityParams
getBarriers, getDirectionsLanguage, getDirectionsLengthUnits, getDirectionsTimeAttributeName, getFacilities, getIncidents, isReturnBarriers, isReturnCFRouteGeometries, isReturnCFRoutes, isReturnDirections, isReturnFacilities, isReturnIncidents, setBarriersByRef, setDirectionsLanguage, setDirectionsLengthUnits, setDirectionsTimeAttributeName, setFacilitiesByRef, setIncidentsByRef, setReturnBarriers, setReturnCFRouteGeometries, setReturnCFRoutes, setReturnDirections, setReturnFacilities, setReturnIncidents
 
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

IID7abe0b88_8fb3_4414_b9f8_60bee554f17a

static final int IID7abe0b88_8fb3_4414_b9f8_60bee554f17a
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

setDirectionsOutputType

void setDirectionsOutputType(int directionsOutputType)
                             throws java.io.IOException,
                                    AutomationException
Type of directions to generate.

Parameters:
directionsOutputType - A com.esri.arcgis.networkanalyst.esriDirectionsOutputType constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDirectionsOutputType

int getDirectionsOutputType()
                            throws java.io.IOException,
                                   AutomationException
Type of directions to generate.

Returns:
A com.esri.arcgis.networkanalyst.esriDirectionsOutputType constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDirectionsStyleName

void setDirectionsStyleName(java.lang.String directionsStyleName)
                            throws java.io.IOException,
                                   AutomationException
Name of the directions style to use when generating directions.

Parameters:
directionsStyleName - The directionsStyleName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDirectionsStyleName

java.lang.String getDirectionsStyleName()
                                        throws java.io.IOException,
                                               AutomationException
Name of the directions style to use when generating directions.

Returns:
The directionsStyleName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPolylineBarriersByRef

void setPolylineBarriersByRef(INAServerLocations barriers)
                              throws java.io.IOException,
                                     AutomationException
RecordSet or array of PropertySets representing polyline 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.

getPolylineBarriers

INAServerLocations getPolylineBarriers()
                                       throws java.io.IOException,
                                              AutomationException
RecordSet or array of PropertySets representing polyline 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.

setPolygonBarriersByRef

void setPolygonBarriersByRef(INAServerLocations barriers)
                             throws java.io.IOException,
                                    AutomationException
RecordSet or array of PropertySets representing polygon 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.

getPolygonBarriers

INAServerLocations getPolygonBarriers()
                                      throws java.io.IOException,
                                             AutomationException
RecordSet or array of PropertySets representing polygon 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.

setReturnPolylineBarriers

void setReturnPolylineBarriers(boolean returnBarriers)
                               throws java.io.IOException,
                                      AutomationException
Indicates if the output polyline 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.

isReturnPolylineBarriers

boolean isReturnPolylineBarriers()
                                 throws java.io.IOException,
                                        AutomationException
Indicates if the output polyline 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.

setReturnPolygonBarriers

void setReturnPolygonBarriers(boolean returnBarriers)
                              throws java.io.IOException,
                                     AutomationException
Indicates if the output polygon 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.

isReturnPolygonBarriers

boolean isReturnPolygonBarriers()
                                throws java.io.IOException,
                                       AutomationException
Indicates if the output polygon 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.