NAServerVRPParams (ArcObjects Java API 10.4)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.networkanalyst
Class NAServerVRPParams

java.lang.Object
  com.esri.arcgis.networkanalyst.NAServerVRPParams

All Implemented Interfaces:: com.esri.arcgis.interop.RemoteObjRef, INAServerSolverParams, INAServerSolverParams2, INAServerSolverParams3, INAServerVRPParams, INASolverSettings, INASolverSettings2, INAVRPSolver, IPersist, IPersistStream, ISupportErrorInfo, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class NAServerVRPParams
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, INAServerSolverParams, INAServerSolverParams2, INAServerSolverParams3, INAServerVRPParams, INASolverSettings, INASolverSettings2, INAVRPSolver, IXMLSerialize, IPersist, IPersistStream, ISupportErrorInfo, IXMLVersionSupport, java.io.Externalizable
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, INAServerSolverParams, INAServerSolverParams2, INAServerSolverParams3, INAServerVRPParams, INASolverSettings, INASolverSettings2, INAVRPSolver, IXMLSerialize, IPersist, IPersistStream, ISupportErrorInfo, IXMLVersionSupport, java.io.Externalizable

COM Class 'NAServerVRPParams'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriNetworkAnalyst.olb'

Description 'Deprecated as of 10.0. A container for the Vehicle Routing Problem solver settings and return parameters used by 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 =

See Also:: Serialized Form

Field Summary
`static long`	`serialVersionUID`

Fields inherited from interface com.esri.arcgis.networkanalyst.INAServerSolverParams3
`IID, IID1bb2d1b6_cabf_4eba_bbd1_d9ed4a92f414, xxDummy`

Fields inherited from interface com.esri.arcgis.networkanalyst.INAServerSolverParams2
`IID1fb9dd3f_a315_4df0_a02a_3358a2bee920`

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

Fields inherited from interface com.esri.arcgis.networkanalyst.INAServerVRPParams
`IID, IID67f3fe93_8b89_4b0d_bc09_31cd05669be3, xxDummy`

Fields inherited from interface com.esri.arcgis.networkanalyst.INASolverSettings2
`IID, IIDd3696546_2831_4aa5_a879_acd66e50a938, xxDummy`

Fields inherited from interface com.esri.arcgis.networkanalyst.INASolverSettings
`IID5a8dc105_0e57_45c8_a01d_0188ce7f7b52`

Fields inherited from interface com.esri.arcgis.networkanalyst.INAVRPSolver
`IID, IID1ae9aa35_d121_4523_aed1_7d25dcabc3fc, xxDummy`

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize
`IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy`

Fields inherited from interface com.esri.arcgis.system.IPersistStream
`IID, IID00000109_0000_0000_c000_000000000046, xxDummy`

Fields inherited from interface com.esri.arcgis.system.IPersist
`IID0000010c_0000_0000_c000_000000000046`

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
`IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy`

Fields inherited from interface com.esri.arcgis.system.IXMLVersionSupport
`IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy`

Constructor Summary
`NAServerVRPParams()` Constructs a NAServerVRPParams using ArcGIS Engine.
`NAServerVRPParams(java.lang.Object obj)` Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. `NAServerVRPParams theNAServerVRPParams = (NAServerVRPParams) obj;`

Method Summary
`void`	`deserialize(IXMLSerializeData data)` Deserializes an object from XML.
`boolean`	`equals(java.lang.Object o)` Compare this object with another
`IStringArray`	`getAccumulateAttributeNames()` The collection of network attribute names to be accumulated with the analysis.
`java.lang.Object`	`getAttributeParameterValue(java.lang.String attributeName, java.lang.String paramName)` The value to use for an attribute parameter within the network dataset.
`INAServerLocations`	`getBarriers()` RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.
`INAServerLocations`	`getBreaks()` RecordSet or array of PropertySets representing Breaks loaded as network locations during analysis.
`int`	`getCapacityCount()` The number of dimensions for object sizes.
`void`	`getClassID(GUID[] pClassID)` getClassID
`static java.lang.String`	`getClsid()` getClsid.
`java.util.Date`	`getDefaultDate()` The date to use for time windows without dates.
`INAServerLocations`	`getDepots()` RecordSet or array of PropertySets representing Depots 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.
`int`	`getDirectionsOutputType()` Type of directions to generate.
`java.lang.String`	`getDirectionsStyleName()` Name of the directions style to use when generating directions.
`java.lang.String`	`getDirectionsTimeAttributeName()` Name of network attribute to use for the drive time when computing directions.
`int`	`getDistanceFieldUnits()` The units for distance fields in the NA classes.
`double`	`getExcessTransitTimePenaltyFactor()` The penalty factor for excess transit time in the objective function.
`INAODCostMatrix`	`getExternalODCostMatrix()` The external OD cost matrix object.
`java.lang.String`	`getHierarchyAttributeName()` The name of the hierarchy attribute to be used in analysis.
`int`	`getHierarchyLevelCount()` The number of levels in the hierarchy attribute.
`IImageDescription`	`getImageDescription()` ImageDescription used when generating the MapImage returned with the analysis results.
`java.lang.String`	`getImpedanceAttributeName()` The network attribute name to be used as the impedance attribute in analysis.
`int`	`getInternalODCostMatrixType()` Indicates the type of internal matrix to be created.
`com.esri.arcgis.interop.Dispatch`	`getJintegraDispatch()` Deprecated. Internal use only.
`java.lang.String`	`getLayerToken()` Token identifying the network analysis layer on the server to use.
`IMapDescription`	`getMapDescription()` MapDescription used when generating the MapImage returned with the analysis results.
`double`	`getMaxSnapTolerance()` Maximum search tolerance used when attempting to load network locations.
`int`	`getMaxValueForHierarchy(int level)` The maximum value of the hierarchy attribute.
`java.lang.String`	`getMinNamespaceSupported()` The minimum namespace the class can serialize to (eg the 90 namespace).
`INAClassCandidateFieldMap[]`	`getNAClassCandidateFieldMaps()` Array of NAClassCandidateFieldMaps .
`java.lang.String`	`getNALayerName()` Network analysis layer name.
`int`	`getNumTransitionToHierarchy(int toLevel)` The number of lower level junctions to explore before searching the next hierarchy level.
`INAServerLocations`	`getOrderPairs()` RecordSet or array of PropertySets representing Order Pairs loaded as network locations during analysis.
`INAServerLocations`	`getOrders()` RecordSet or array of PropertySets representing Orders loaded as network locations during analysis.
`int`	`getOutputLines()` Indicates how route lines are generated.
`ISpatialReference`	`getOutputSpatialReference()` Spatial reference of the geometries returned with the analysis results.
`INAServerLocations`	`getPolygonBarriers()` RecordSet or array of PropertySets representing Polygon Barriers loaded as collections of network locations during analysis.
`INAServerLocations`	`getPolylineBarriers()` RecordSet or array of PropertySets representing Polyline Barriers loaded as collections of network locations during analysis.
`IStringArray`	`getRestrictionAttributeNames()` The collection of network attribute names to be used as restrictions with the analysis.
`int`	`getRestrictUTurns()` Indicates how U-Turns should be restricted in the analysis.
`INAServerLocations`	`getRouteRenewals()` RecordSet or array of PropertySets representing Route Renewals loaded as network locations during analysis.
`INAServerLocations`	`getRoutes()` RecordSet or array of PropertySets representing Routes loaded as network locations during analysis.
`INAServerLocations`	`getRouteSeedPoints()` RecordSet or array of PropertySets representing Route Seed Points loaded as network locations during analysis.
`INAServerLocations`	`getRouteZones()` RecordSet or array of PropertySets representing Route Zones loaded as network locations during analysis.
`void`	`getSizeMax(_ULARGE_INTEGER[] pcbSize)` getSizeMax
`double`	`getSnapTolerance()` Minimum search tolerance used when attempting to load network locations.
`int`	`getSnapToleranceUnits()` Length units of the SnapTolerance and MaxSnapTolerance.
`INAServerLocations`	`getSpecialties()` RecordSet or array of PropertySets representing Specialties loaded as network locations during analysis.
`int`	`getTimeFieldUnits()` The units for time fields in the NA classes.
`double`	`getTimeWindowViolationPenaltyFactor()` The penalty factor for time window violation in the objective function.
`java.lang.String`	`getTravelMode()` Specifies the travel mode.
`int`	`hashCode()` the hashcode for this object
`void`	`interfaceSupportsErrorInfo(GUID riid)` interfaceSupportsErrorInfo
`void`	`isDirty()` isDirty
`boolean`	`isGenerateInternalRouteContext()` Indicates if the internal route context should be generated.
`boolean`	`isIgnoreInvalidLocations()` Indicates if invalid locations should be ignored or raise an error.
`boolean`	`isResetHierarchyRangesOnBind()` Indicates if the hierarchy ranges will be reset to the network dataset's hierarchy settings when the solver is bound.
`boolean`	`isReturnBarriers()` Indicates if the output barriers recordset should be returned with the analysis results.
`boolean`	`isReturnBreaks()` Indicates if the output Breaks recordset should be returned with the analysis results.
`boolean`	`isReturnCompactDirections()` Indicates if compact directions should be generated and returned with the analysis results.
`boolean`	`isReturnDepots()` Indicates if the output Depots recordset should be returned with the analysis results.
`boolean`	`isReturnDepotVisits()` Indicates if the output Depot Visits recordset should be returned with the analysis results.
`boolean`	`isReturnMap()` Indicates if a MapImage should be generated and returned with the analysis results.
`boolean`	`isReturnOrderPairs()` Indicates if the output OrderPairs recordset should be returned with the analysis results.
`boolean`	`isReturnOrders()` Indicates if the output Orders recordset should be returned with the analysis results.
`boolean`	`isReturnPartialResultsOnError()` Indicates if the result object should be returned even if an error was generated during the solve operation.
`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.
`boolean`	`isReturnRouteRenewals()` Indicates if the output Route Renewals recordset should be returned with the analysis results.
`boolean`	`isReturnRoutes()` Indicates if the output Routes recordset should be returned with the analysis results.
`boolean`	`isReturnRouteSeedPoints()` Indicates if the Route Seed Points recordset should be returned with the analysis results.
`boolean`	`isReturnRouteZones()` Indicates if the Route Zones recordset should be returned with the analysis results.
`boolean`	`isReturnSpecialties()` Indicates if the Specialties recordset should be returned with the analysis results.
`boolean`	`isSaveLayerOnServer()` Indicates if the resulting analysis layer should be saved on the server.
`boolean`	`isUseHierarchy()` Indicates if the hierarchy attribute for the network should be used in analysis.
`void`	`load(IStream pstm)` load
`void`	`readExternal(java.io.ObjectInput in)`
`void`	`release()` Release a NAServerVRPParams.
`void`	`save(IStream pstm, int fClearDirty)` save
`void`	`serialize(IXMLSerializeData data)` Serializes an object to XML.
`void`	`setAccumulateAttributeNamesByRef(IStringArray attributeNames)` The collection of network attribute names to be accumulated with the analysis.
`void`	`setAttributeParameterValue(java.lang.String attributeName, java.lang.String paramName, java.lang.Object value)` The value to use for an attribute parameter within the network dataset.
`void`	`setBarriersByRef(INAServerLocations barriers)` RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.
`void`	`setBreaksByRef(INAServerLocations breaks)` RecordSet or array of PropertySets representing Breaks loaded as network locations during analysis.
`void`	`setCapacityCount(int value)` The number of dimensions for object sizes.
`void`	`setDefaultDate(java.util.Date date)` The date to use for time windows without dates.
`void`	`setDepotsByRef(INAServerLocations depots)` RecordSet or array of PropertySets representing Depots 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`	`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`	`setDirectionsTimeAttributeName(java.lang.String directionsTimeAttributeName)` Name of network attribute to use for the drive time when computing directions.
`void`	`setDistanceFieldUnits(int units)` The units for distance fields in the NA classes.
`void`	`setExcessTransitTimePenaltyFactor(double value)` The penalty factor for excess transit time in the objective function.
`void`	`setExternalODCostMatrixByRef(INAODCostMatrix matrix)` The external OD cost matrix object.
`void`	`setGenerateInternalRouteContext(boolean value)` Indicates if the internal route context should be generated.
`void`	`setHierarchyAttributeName(java.lang.String attributeName)` The name of the hierarchy attribute to be used in analysis.
`void`	`setHierarchyLevelCount(int count)` The number of levels in the hierarchy attribute.
`void`	`setIgnoreInvalidLocations(boolean ignoreInvalidLocations)` Indicates if invalid locations should be ignored or raise an error.
`void`	`setImageDescriptionByRef(IImageDescription imageDescription)` ImageDescription used when generating the MapImage returned with the analysis results.
`void`	`setImpedanceAttributeName(java.lang.String attributeName)` The network attribute name to be used as the impedance attribute in analysis.
`void`	`setInternalODCostMatrixType(int type)` Indicates the type of internal matrix to be created.
`void`	`setLayerToken(java.lang.String layerToken)` Token identifying the network analysis layer on the server to use.
`void`	`setMapDescriptionByRef(IMapDescription mapDescription)` MapDescription used when generating the MapImage returned with the analysis results.
`void`	`setMaxSnapTolerance(double maxSnapTolerance)` Maximum search tolerance used when attempting to load network locations.
`void`	`setMaxValueForHierarchy(int level, int value)` The maximum value of the hierarchy attribute.
`void`	`setNAClassCandidateFieldMaps(INAClassCandidateFieldMap[] ppNAClassCandidateFieldMaps)` Array of NAClassCandidateFieldMaps .
`void`	`setNALayerName(java.lang.String nALayerName)` Network analysis layer name.
`void`	`setNumTransitionToHierarchy(int toLevel, int value)` The number of lower level junctions to explore before searching the next hierarchy level.
`void`	`setOrderPairsByRef(INAServerLocations orderPairs)` RecordSet or array of PropertySets representing Order Pairs loaded as network locations during analysis.
`void`	`setOrdersByRef(INAServerLocations orders)` RecordSet or array of PropertySets representing Orders loaded as network locations during analysis.
`void`	`setOutputLines(int value)` Indicates how route lines are generated.
`void`	`setOutputSpatialReferenceByRef(ISpatialReference spatialReference)` Spatial reference of the geometries returned with the analysis results.
`void`	`setPolygonBarriersByRef(INAServerLocations polygonBarriers)` RecordSet or array of PropertySets representing Polygon Barriers loaded as collections of network locations during analysis.
`void`	`setPolylineBarriersByRef(INAServerLocations polylineBarriers)` RecordSet or array of PropertySets representing Polyline Barriers loaded as collections of network locations during analysis.
`void`	`setResetHierarchyRangesOnBind(boolean value)` Indicates if the hierarchy ranges will be reset to the network dataset's hierarchy settings when the solver is bound.
`void`	`setRestrictionAttributeNamesByRef(IStringArray attributeName)` The collection of network attribute names to be used as restrictions with the analysis.
`void`	`setRestrictUTurns(int backtrack)` Indicates how U-Turns should be restricted in the analysis.
`void`	`setReturnBarriers(boolean returnBarriers)` Indicates if the output barriers recordset should be returned with the analysis results.
`void`	`setReturnBreaks(boolean returnBreaks)` Indicates if the output Breaks recordset should be returned with the analysis results.
`void`	`setReturnCompactDirections(boolean returnCompactDirections)` Indicates if compact directions should be generated and returned with the analysis results.
`void`	`setReturnDepots(boolean returnDepots)` Indicates if the output Depots recordset should be returned with the analysis results.
`void`	`setReturnDepotVisits(boolean returnDepotVisits)` Indicates if the output Depot Visits recordset should be returned with the analysis results.
`void`	`setReturnMap(boolean returnMap)` Indicates if a MapImage should be generated and returned with the analysis results.
`void`	`setReturnOrderPairs(boolean returnOrderPairs)` Indicates if the output OrderPairs recordset should be returned with the analysis results.
`void`	`setReturnOrders(boolean returnOrders)` Indicates if the output Orders recordset should be returned with the analysis results.
`void`	`setReturnPartialResultsOnError(boolean returnPartialResultsOnError)` Indicates if the result object should be returned even if an error was generated during the solve operation.
`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.
`void`	`setReturnRouteRenewals(boolean returnRouteRenewals)` Indicates if the output Route Renewals recordset should be returned with the analysis results.
`void`	`setReturnRoutes(boolean returnRoutes)` Indicates if the output Routes recordset should be returned with the analysis results.
`void`	`setReturnRouteSeedPoints(boolean returnRouteSeedPoints)` Indicates if the Route Seed Points recordset should be returned with the analysis results.
`void`	`setReturnRouteZones(boolean returnRouteZones)` Indicates if the Route Zones recordset should be returned with the analysis results.
`void`	`setReturnSpecialties(boolean returnSpecialties)` Indicates if the Specialties recordset should be returned with the analysis results.
`void`	`setRouteRenewalsByRef(INAServerLocations routeRenewals)` RecordSet or array of PropertySets representing Route Renewals loaded as network locations during analysis.
`void`	`setRoutesByRef(INAServerLocations routes)` RecordSet or array of PropertySets representing Routes loaded as network locations during analysis.
`void`	`setRouteSeedPointsByRef(INAServerLocations routeSeedPoints)` RecordSet or array of PropertySets representing Route Seed Points loaded as network locations during analysis.
`void`	`setRouteZonesByRef(INAServerLocations routeZones)` RecordSet or array of PropertySets representing Route Zones loaded as network locations during analysis.
`void`	`setSaveLayerOnServer(boolean saveLayerOnServer)` Indicates if the resulting analysis layer should be saved on the server.
`void`	`setSnapTolerance(double snapTolerance)` Minimum search tolerance used when attempting to load network locations.
`void`	`setSnapToleranceUnits(int snapToleranceUnits)` Length units of the SnapTolerance and MaxSnapTolerance.
`void`	`setSpecialtiesByRef(INAServerLocations specialties)` RecordSet or array of PropertySets representing Specialties loaded as network locations during analysis.
`void`	`setTimeFieldUnits(int units)` The units for time fields in the NA classes.
`void`	`setTimeWindowViolationPenaltyFactor(double value)` The penalty factor for time window violation in the objective function.
`void`	`setTravelMode(java.lang.String value)` Specifies the travel mode.
`void`	`setUseHierarchy(boolean useHierarchy)` Indicates if the hierarchy attribute for the network should be used in analysis.
`void`	`writeExternal(java.io.ObjectOutput out)`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:: Constant Field Values

Constructor Detail

NAServerVRPParams

public NAServerVRPParams()
                  throws java.io.IOException,
                         java.net.UnknownHostException

Constructs a NAServerVRPParams using ArcGIS Engine.

Throws:: java.io.IOException - if there are interop problems; java.net.UnknownHostException - if there are interop problems

NAServerVRPParams

public NAServerVRPParams(java.lang.Object obj)
                  throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NAServerVRPParams theNAServerVRPParams = (NAServerVRPParams) obj;

Construct a NAServerVRPParams using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to NAServerVRPParams.

Parameters:: obj - an object returned from ArcGIS Engine or Server
Throws:: java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:: equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:: hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:: getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a NAServerVRPParams.

Specified by:: release in interface com.esri.arcgis.interop.RemoteObjRef

setNALayerName

public void setNALayerName(java.lang.String nALayerName)
                    throws java.io.IOException,
                           AutomationException

Network analysis layer name.

Specified by:: setNALayerName in interface INAServerSolverParams

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

getNALayerName

public java.lang.String getNALayerName()
                                throws java.io.IOException,
                                       AutomationException

Network analysis layer name.

Specified by:: getNALayerName in interface INAServerSolverParams

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

setSnapTolerance

public void setSnapTolerance(double snapTolerance)
                      throws java.io.IOException,
                             AutomationException

Minimum search tolerance used when attempting to load network locations.

Specified by:: setSnapTolerance in interface INAServerSolverParams

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

getSnapTolerance

public double getSnapTolerance()
                        throws java.io.IOException,
                               AutomationException

Minimum search tolerance used when attempting to load network locations.

Specified by:: getSnapTolerance in interface INAServerSolverParams

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

setMaxSnapTolerance

public void setMaxSnapTolerance(double maxSnapTolerance)
                         throws java.io.IOException,
                                AutomationException

Maximum search tolerance used when attempting to load network locations.

Specified by:: setMaxSnapTolerance in interface INAServerSolverParams

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

getMaxSnapTolerance

public double getMaxSnapTolerance()
                           throws java.io.IOException,
                                  AutomationException

Maximum search tolerance used when attempting to load network locations.

Specified by:: getMaxSnapTolerance in interface INAServerSolverParams

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

setSnapToleranceUnits

public void setSnapToleranceUnits(int snapToleranceUnits)
                           throws java.io.IOException,
                                  AutomationException

Length units of the SnapTolerance and MaxSnapTolerance.

Specified by:: setSnapToleranceUnits in interface INAServerSolverParams

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

getSnapToleranceUnits

public int getSnapToleranceUnits()
                          throws java.io.IOException,
                                 AutomationException

Length units of the SnapTolerance and MaxSnapTolerance.

Specified by:: getSnapToleranceUnits in interface INAServerSolverParams

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

setNAClassCandidateFieldMaps

public void setNAClassCandidateFieldMaps(INAClassCandidateFieldMap[] ppNAClassCandidateFieldMaps)
                                  throws java.io.IOException,
                                         AutomationException

Array of NAClassCandidateFieldMaps .

Specified by:: setNAClassCandidateFieldMaps in interface INAServerSolverParams

Parameters:: ppNAClassCandidateFieldMaps - A reference to a com.esri.arcgis.networkanalyst.INAClassCandidateFieldMap array (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getNAClassCandidateFieldMaps

public INAClassCandidateFieldMap[] getNAClassCandidateFieldMaps()
                                                         throws java.io.IOException,
                                                                AutomationException

Array of NAClassCandidateFieldMaps .

Specified by:: getNAClassCandidateFieldMaps in interface INAServerSolverParams

Returns:: A reference to a com.esri.arcgis.networkanalyst.INAClassCandidateFieldMap array
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setReturnMap

public void setReturnMap(boolean returnMap)
                  throws java.io.IOException,
                         AutomationException

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

Specified by:: setReturnMap in interface INAServerSolverParams

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

isReturnMap

public boolean isReturnMap()
                    throws java.io.IOException,
                           AutomationException

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

Specified by:: isReturnMap in interface INAServerSolverParams

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

setMapDescriptionByRef

public void setMapDescriptionByRef(IMapDescription mapDescription)
                            throws java.io.IOException,
                                   AutomationException

MapDescription used when generating the MapImage returned with the analysis results.

Specified by:: setMapDescriptionByRef in interface INAServerSolverParams

Parameters:: mapDescription - A reference to a com.esri.arcgis.carto.IMapDescription (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMapDescription

public IMapDescription getMapDescription()
                                  throws java.io.IOException,
                                         AutomationException

MapDescription used when generating the MapImage returned with the analysis results.

Specified by:: getMapDescription in interface INAServerSolverParams

Returns:: A reference to a com.esri.arcgis.carto.IMapDescription
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setImageDescriptionByRef

public void setImageDescriptionByRef(IImageDescription imageDescription)
                              throws java.io.IOException,
                                     AutomationException

ImageDescription used when generating the MapImage returned with the analysis results.

Specified by:: setImageDescriptionByRef in interface INAServerSolverParams

Parameters:: imageDescription - A reference to a com.esri.arcgis.carto.IImageDescription (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getImageDescription

public IImageDescription getImageDescription()
                                      throws java.io.IOException,
                                             AutomationException

ImageDescription used when generating the MapImage returned with the analysis results.

Specified by:: getImageDescription in interface INAServerSolverParams

Returns:: A reference to a com.esri.arcgis.carto.IImageDescription
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setOutputSpatialReferenceByRef

public void setOutputSpatialReferenceByRef(ISpatialReference spatialReference)
                                    throws java.io.IOException,
                                           AutomationException

Spatial reference of the geometries returned with the analysis results.

Specified by:: setOutputSpatialReferenceByRef in interface INAServerSolverParams

Parameters:: spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getOutputSpatialReference

public ISpatialReference getOutputSpatialReference()
                                            throws java.io.IOException,
                                                   AutomationException

Spatial reference of the geometries returned with the analysis results.

Specified by:: getOutputSpatialReference in interface INAServerSolverParams

Returns:: A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setReturnPartialResultsOnError

public void setReturnPartialResultsOnError(boolean returnPartialResultsOnError)
                                    throws java.io.IOException,
                                           AutomationException

Indicates if the result object should be returned even if an error was generated during the solve operation.

Specified by:: setReturnPartialResultsOnError in interface INAServerSolverParams2

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

isReturnPartialResultsOnError

public boolean isReturnPartialResultsOnError()
                                      throws java.io.IOException,
                                             AutomationException

Indicates if the result object should be returned even if an error was generated during the solve operation.

Specified by:: isReturnPartialResultsOnError in interface INAServerSolverParams2

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

setSaveLayerOnServer

public void setSaveLayerOnServer(boolean saveLayerOnServer)
                          throws java.io.IOException,
                                 AutomationException

Indicates if the resulting analysis layer should be saved on the server.

Specified by:: setSaveLayerOnServer in interface INAServerSolverParams2

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

isSaveLayerOnServer

public boolean isSaveLayerOnServer()
                            throws java.io.IOException,
                                   AutomationException

Indicates if the resulting analysis layer should be saved on the server.

Specified by:: isSaveLayerOnServer in interface INAServerSolverParams2

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

setLayerToken

public void setLayerToken(java.lang.String layerToken)
                   throws java.io.IOException,
                          AutomationException

Token identifying the network analysis layer on the server to use.

Specified by:: setLayerToken in interface INAServerSolverParams2

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

getLayerToken

public java.lang.String getLayerToken()
                               throws java.io.IOException,
                                      AutomationException

Token identifying the network analysis layer on the server to use.

Specified by:: getLayerToken in interface INAServerSolverParams2

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

getTravelMode

public java.lang.String getTravelMode()
                               throws java.io.IOException,
                                      AutomationException

Specifies the travel mode.

Specified by:: getTravelMode in interface INAServerSolverParams3

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

setTravelMode

public void setTravelMode(java.lang.String value)
                   throws java.io.IOException,
                          AutomationException

Specifies the travel mode.

Specified by:: setTravelMode in interface INAServerSolverParams3

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

setOrdersByRef

public void setOrdersByRef(INAServerLocations orders)
                    throws java.io.IOException,
                           AutomationException

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

Specified by:: setOrdersByRef in interface INAServerVRPParams

Parameters:: orders - 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.

getOrders

public INAServerLocations getOrders()
                             throws java.io.IOException,
                                    AutomationException

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

Specified by:: getOrders in interface INAServerVRPParams

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.

setDepotsByRef

public void setDepotsByRef(INAServerLocations depots)
                    throws java.io.IOException,
                           AutomationException

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

Specified by:: setDepotsByRef in interface INAServerVRPParams

Parameters:: depots - 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.

getDepots

public INAServerLocations getDepots()
                             throws java.io.IOException,
                                    AutomationException

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

Specified by:: getDepots in interface INAServerVRPParams

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.

setRoutesByRef

public void setRoutesByRef(INAServerLocations routes)
                    throws java.io.IOException,
                           AutomationException

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

Specified by:: setRoutesByRef in interface INAServerVRPParams

Parameters:: routes - 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.

getRoutes

public INAServerLocations getRoutes()
                             throws java.io.IOException,
                                    AutomationException

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

Specified by:: getRoutes in interface INAServerVRPParams

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.

setBreaksByRef

public void setBreaksByRef(INAServerLocations breaks)
                    throws java.io.IOException,
                           AutomationException

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

Specified by:: setBreaksByRef in interface INAServerVRPParams

Parameters:: breaks - 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.

getBreaks

public INAServerLocations getBreaks()
                             throws java.io.IOException,
                                    AutomationException

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

Specified by:: getBreaks in interface INAServerVRPParams

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.

setRouteZonesByRef

public void setRouteZonesByRef(INAServerLocations routeZones)
                        throws java.io.IOException,
                               AutomationException

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

Specified by:: setRouteZonesByRef in interface INAServerVRPParams

Parameters:: routeZones - 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.

getRouteZones

public INAServerLocations getRouteZones()
                                 throws java.io.IOException,
                                        AutomationException

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

Specified by:: getRouteZones in interface INAServerVRPParams

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.

setRouteSeedPointsByRef

public void setRouteSeedPointsByRef(INAServerLocations routeSeedPoints)
                             throws java.io.IOException,
                                    AutomationException

RecordSet or array of PropertySets representing Route Seed Points loaded as network locations during analysis.

Specified by:: setRouteSeedPointsByRef in interface INAServerVRPParams

Parameters:: routeSeedPoints - 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.

getRouteSeedPoints

public INAServerLocations getRouteSeedPoints()
                                      throws java.io.IOException,
                                             AutomationException

RecordSet or array of PropertySets representing Route Seed Points loaded as network locations during analysis.

Specified by:: getRouteSeedPoints in interface INAServerVRPParams

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.

setRouteRenewalsByRef

public void setRouteRenewalsByRef(INAServerLocations routeRenewals)
                           throws java.io.IOException,
                                  AutomationException

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

Specified by:: setRouteRenewalsByRef in interface INAServerVRPParams

Parameters:: routeRenewals - 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.

getRouteRenewals

public INAServerLocations getRouteRenewals()
                                    throws java.io.IOException,
                                           AutomationException

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

Specified by:: getRouteRenewals in interface INAServerVRPParams

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.

setSpecialtiesByRef

public void setSpecialtiesByRef(INAServerLocations specialties)
                         throws java.io.IOException,
                                AutomationException

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

Specified by:: setSpecialtiesByRef in interface INAServerVRPParams

Parameters:: specialties - 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.

getSpecialties

public INAServerLocations getSpecialties()
                                  throws java.io.IOException,
                                         AutomationException

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

Specified by:: getSpecialties in interface INAServerVRPParams

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.

setOrderPairsByRef

public void setOrderPairsByRef(INAServerLocations orderPairs)
                        throws java.io.IOException,
                               AutomationException

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

Specified by:: setOrderPairsByRef in interface INAServerVRPParams

Parameters:: orderPairs - 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.

getOrderPairs

public INAServerLocations getOrderPairs()
                                 throws java.io.IOException,
                                        AutomationException

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

Specified by:: getOrderPairs in interface INAServerVRPParams

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

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

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

Specified by:: setBarriersByRef in interface INAServerVRPParams

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

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

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

Specified by:: getBarriers in interface INAServerVRPParams

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.

setPolylineBarriersByRef

public void setPolylineBarriersByRef(INAServerLocations polylineBarriers)
                              throws java.io.IOException,
                                     AutomationException

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

Specified by:: setPolylineBarriersByRef in interface INAServerVRPParams

Parameters:: polylineBarriers - 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

public INAServerLocations getPolylineBarriers()
                                       throws java.io.IOException,
                                              AutomationException

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

Specified by:: getPolylineBarriers in interface INAServerVRPParams

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

public void setPolygonBarriersByRef(INAServerLocations polygonBarriers)
                             throws java.io.IOException,
                                    AutomationException

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

Specified by:: setPolygonBarriersByRef in interface INAServerVRPParams

Parameters:: polygonBarriers - 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

public INAServerLocations getPolygonBarriers()
                                      throws java.io.IOException,
                                             AutomationException

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

Specified by:: getPolygonBarriers in interface INAServerVRPParams

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.

setReturnOrderPairs

public void setReturnOrderPairs(boolean returnOrderPairs)
                         throws java.io.IOException,
                                AutomationException

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

Specified by:: setReturnOrderPairs in interface INAServerVRPParams

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

isReturnOrderPairs

public boolean isReturnOrderPairs()
                           throws java.io.IOException,
                                  AutomationException

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

Specified by:: isReturnOrderPairs in interface INAServerVRPParams

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

setReturnOrders

public void setReturnOrders(boolean returnOrders)
                     throws java.io.IOException,
                            AutomationException

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

Specified by:: setReturnOrders in interface INAServerVRPParams

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

isReturnOrders

public boolean isReturnOrders()
                       throws java.io.IOException,
                              AutomationException

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

Specified by:: isReturnOrders in interface INAServerVRPParams

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

setReturnDepots

public void setReturnDepots(boolean returnDepots)
                     throws java.io.IOException,
                            AutomationException

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

Specified by:: setReturnDepots in interface INAServerVRPParams

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

isReturnDepots

public boolean isReturnDepots()
                       throws java.io.IOException,
                              AutomationException

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

Specified by:: isReturnDepots in interface INAServerVRPParams

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

setReturnRoutes

public void setReturnRoutes(boolean returnRoutes)
                     throws java.io.IOException,
                            AutomationException

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

Specified by:: setReturnRoutes in interface INAServerVRPParams

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

isReturnRoutes

public boolean isReturnRoutes()
                       throws java.io.IOException,
                              AutomationException

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

Specified by:: isReturnRoutes in interface INAServerVRPParams

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

setReturnDepotVisits

public void setReturnDepotVisits(boolean returnDepotVisits)
                          throws java.io.IOException,
                                 AutomationException

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

Specified by:: setReturnDepotVisits in interface INAServerVRPParams

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

isReturnDepotVisits

public boolean isReturnDepotVisits()
                            throws java.io.IOException,
                                   AutomationException

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

Specified by:: isReturnDepotVisits in interface INAServerVRPParams

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

setReturnBreaks

public void setReturnBreaks(boolean returnBreaks)
                     throws java.io.IOException,
                            AutomationException

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

Specified by:: setReturnBreaks in interface INAServerVRPParams

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

isReturnBreaks

public boolean isReturnBreaks()
                       throws java.io.IOException,
                              AutomationException

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

Specified by:: isReturnBreaks in interface INAServerVRPParams

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

setReturnRouteRenewals

public void setReturnRouteRenewals(boolean returnRouteRenewals)
                            throws java.io.IOException,
                                   AutomationException

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

Specified by:: setReturnRouteRenewals in interface INAServerVRPParams

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

isReturnRouteRenewals

public boolean isReturnRouteRenewals()
                              throws java.io.IOException,
                                     AutomationException

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

Specified by:: isReturnRouteRenewals in interface INAServerVRPParams

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

setReturnRouteSeedPoints

public void setReturnRouteSeedPoints(boolean returnRouteSeedPoints)
                              throws java.io.IOException,
                                     AutomationException

Indicates if the Route Seed Points recordset should be returned with the analysis results.

Specified by:: setReturnRouteSeedPoints in interface INAServerVRPParams

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

isReturnRouteSeedPoints

public boolean isReturnRouteSeedPoints()
                                throws java.io.IOException,
                                       AutomationException

Indicates if the Route Seed Points recordset should be returned with the analysis results.

Specified by:: isReturnRouteSeedPoints in interface INAServerVRPParams

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

setReturnRouteZones

public void setReturnRouteZones(boolean returnRouteZones)
                         throws java.io.IOException,
                                AutomationException

Indicates if the Route Zones recordset should be returned with the analysis results.

Specified by:: setReturnRouteZones in interface INAServerVRPParams

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

isReturnRouteZones

public boolean isReturnRouteZones()
                           throws java.io.IOException,
                                  AutomationException

Indicates if the Route Zones recordset should be returned with the analysis results.

Specified by:: isReturnRouteZones in interface INAServerVRPParams

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

setReturnSpecialties

public void setReturnSpecialties(boolean returnSpecialties)
                          throws java.io.IOException,
                                 AutomationException

Indicates if the Specialties recordset should be returned with the analysis results.

Specified by:: setReturnSpecialties in interface INAServerVRPParams

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

isReturnSpecialties

public boolean isReturnSpecialties()
                            throws java.io.IOException,
                                   AutomationException

Indicates if the Specialties recordset should be returned with the analysis results.

Specified by:: isReturnSpecialties in interface INAServerVRPParams

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

setReturnBarriers

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

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

Specified by:: setReturnBarriers in interface INAServerVRPParams

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

isReturnBarriers

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

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

Specified by:: isReturnBarriers in interface INAServerVRPParams

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

setReturnPolylineBarriers

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

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

Specified by:: setReturnPolylineBarriers in interface INAServerVRPParams

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

isReturnPolylineBarriers

public boolean isReturnPolylineBarriers()
                                 throws java.io.IOException,
                                        AutomationException

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

Specified by:: isReturnPolylineBarriers in interface INAServerVRPParams

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

setReturnPolygonBarriers

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

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

Specified by:: setReturnPolygonBarriers in interface INAServerVRPParams

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

isReturnPolygonBarriers

public boolean isReturnPolygonBarriers()
                                throws java.io.IOException,
                                       AutomationException

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

Specified by:: isReturnPolygonBarriers in interface INAServerVRPParams

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

setReturnCompactDirections

public void setReturnCompactDirections(boolean returnCompactDirections)
                                throws java.io.IOException,
                                       AutomationException

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

Specified by:: setReturnCompactDirections in interface INAServerVRPParams

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

isReturnCompactDirections

public boolean isReturnCompactDirections()
                                  throws java.io.IOException,
                                         AutomationException

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

Specified by:: isReturnCompactDirections in interface INAServerVRPParams

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

setDirectionsLanguage

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

Language to use when computing directions.

Specified by:: setDirectionsLanguage in interface INAServerVRPParams

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

getDirectionsLanguage

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

Language to use when computing directions.

Specified by:: getDirectionsLanguage in interface INAServerVRPParams

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

setDirectionsLengthUnits

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

Length units to use when computing directions.

Specified by:: setDirectionsLengthUnits in interface INAServerVRPParams

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

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

Length units to use when computing directions.

Specified by:: getDirectionsLengthUnits in interface INAServerVRPParams

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.

setDirectionsOutputType

public void setDirectionsOutputType(int directionsOutputType)
                             throws java.io.IOException,
                                    AutomationException

Type of directions to generate.

Specified by:: setDirectionsOutputType in interface INAServerVRPParams

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

public int getDirectionsOutputType()
                            throws java.io.IOException,
                                   AutomationException

Type of directions to generate.

Specified by:: getDirectionsOutputType in interface INAServerVRPParams

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

public void setDirectionsStyleName(java.lang.String directionsStyleName)
                            throws java.io.IOException,
                                   AutomationException

Name of the directions style to use when generating directions.

Specified by:: setDirectionsStyleName in interface INAServerVRPParams

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

getDirectionsStyleName

public java.lang.String getDirectionsStyleName()
                                        throws java.io.IOException,
                                               AutomationException

Name of the directions style to use when generating directions.

Specified by:: getDirectionsStyleName in interface INAServerVRPParams

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

setDirectionsTimeAttributeName

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

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

Specified by:: setDirectionsTimeAttributeName in interface INAServerVRPParams

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

getDirectionsTimeAttributeName

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

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

Specified by:: getDirectionsTimeAttributeName in interface INAServerVRPParams

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

getAccumulateAttributeNames

public IStringArray getAccumulateAttributeNames()
                                         throws java.io.IOException,
                                                AutomationException

The collection of network attribute names to be accumulated with the analysis.

Specified by:: getAccumulateAttributeNames in interface INASolverSettings

Returns:: A reference to a com.esri.arcgis.system.IStringArray
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setAccumulateAttributeNamesByRef

public void setAccumulateAttributeNamesByRef(IStringArray attributeNames)
                                      throws java.io.IOException,
                                             AutomationException

The collection of network attribute names to be accumulated with the analysis.

Specified by:: setAccumulateAttributeNamesByRef in interface INASolverSettings

Parameters:: attributeNames - A reference to a com.esri.arcgis.system.IStringArray (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setImpedanceAttributeName

public void setImpedanceAttributeName(java.lang.String attributeName)
                               throws java.io.IOException,
                                      AutomationException

The network attribute name to be used as the impedance attribute in analysis.

Specified by:: setImpedanceAttributeName in interface INASolverSettings

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

getImpedanceAttributeName

public java.lang.String getImpedanceAttributeName()
                                           throws java.io.IOException,
                                                  AutomationException

The network attribute name to be used as the impedance attribute in analysis.

Specified by:: getImpedanceAttributeName in interface INASolverSettings

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

setIgnoreInvalidLocations

public void setIgnoreInvalidLocations(boolean ignoreInvalidLocations)
                               throws java.io.IOException,
                                      AutomationException

Indicates if invalid locations should be ignored or raise an error.

Specified by:: setIgnoreInvalidLocations in interface INASolverSettings

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

isIgnoreInvalidLocations

public boolean isIgnoreInvalidLocations()
                                 throws java.io.IOException,
                                        AutomationException

Indicates if invalid locations should be ignored or raise an error.

Specified by:: isIgnoreInvalidLocations in interface INASolverSettings

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

getRestrictionAttributeNames

public IStringArray getRestrictionAttributeNames()
                                          throws java.io.IOException,
                                                 AutomationException

The collection of network attribute names to be used as restrictions with the analysis.

Specified by:: getRestrictionAttributeNames in interface INASolverSettings

Returns:: A reference to a com.esri.arcgis.system.IStringArray
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setRestrictionAttributeNamesByRef

public void setRestrictionAttributeNamesByRef(IStringArray attributeName)
                                       throws java.io.IOException,
                                              AutomationException

The collection of network attribute names to be used as restrictions with the analysis.

Specified by:: setRestrictionAttributeNamesByRef in interface INASolverSettings

Parameters:: attributeName - A reference to a com.esri.arcgis.system.IStringArray (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setRestrictUTurns

public void setRestrictUTurns(int backtrack)
                       throws java.io.IOException,
                              AutomationException

Indicates how U-Turns should be restricted in the analysis.

Specified by:: setRestrictUTurns in interface INASolverSettings

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

getRestrictUTurns

public int getRestrictUTurns()
                      throws java.io.IOException,
                             AutomationException

Indicates how U-Turns should be restricted in the analysis.

Specified by:: getRestrictUTurns in interface INASolverSettings

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

setUseHierarchy

public void setUseHierarchy(boolean useHierarchy)
                     throws java.io.IOException,
                            AutomationException

Indicates if the hierarchy attribute for the network should be used in analysis.

Specified by:: setUseHierarchy in interface INASolverSettings

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

isUseHierarchy

public boolean isUseHierarchy()
                       throws java.io.IOException,
                              AutomationException

Indicates if the hierarchy attribute for the network should be used in analysis.

Specified by:: isUseHierarchy in interface INASolverSettings

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

setHierarchyAttributeName

public void setHierarchyAttributeName(java.lang.String attributeName)
                               throws java.io.IOException,
                                      AutomationException

The name of the hierarchy attribute to be used in analysis.

Specified by:: setHierarchyAttributeName in interface INASolverSettings

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

getHierarchyAttributeName

public java.lang.String getHierarchyAttributeName()
                                           throws java.io.IOException,
                                                  AutomationException

The name of the hierarchy attribute to be used in analysis.

Specified by:: getHierarchyAttributeName in interface INASolverSettings

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

setHierarchyLevelCount

public void setHierarchyLevelCount(int count)
                            throws java.io.IOException,
                                   AutomationException

The number of levels in the hierarchy attribute.

Specified by:: setHierarchyLevelCount in interface INASolverSettings

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

getHierarchyLevelCount

public int getHierarchyLevelCount()
                           throws java.io.IOException,
                                  AutomationException

The number of levels in the hierarchy attribute.

Specified by:: getHierarchyLevelCount in interface INASolverSettings

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

setMaxValueForHierarchy

public void setMaxValueForHierarchy(int level,
                                    int value)
                             throws java.io.IOException,
                                    AutomationException

The maximum value of the hierarchy attribute.

Specified by:: setMaxValueForHierarchy in interface INASolverSettings

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

getMaxValueForHierarchy

public int getMaxValueForHierarchy(int level)
                            throws java.io.IOException,
                                   AutomationException

The maximum value of the hierarchy attribute.

Specified by:: getMaxValueForHierarchy in interface INASolverSettings

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

setNumTransitionToHierarchy

public void setNumTransitionToHierarchy(int toLevel,
                                        int value)
                                 throws java.io.IOException,
                                        AutomationException

The number of lower level junctions to explore before searching the next hierarchy level.

Specified by:: setNumTransitionToHierarchy in interface INASolverSettings

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

getNumTransitionToHierarchy

public int getNumTransitionToHierarchy(int toLevel)
                                throws java.io.IOException,
                                       AutomationException

The number of lower level junctions to explore before searching the next hierarchy level.

Specified by:: getNumTransitionToHierarchy in interface INASolverSettings

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

isResetHierarchyRangesOnBind

public boolean isResetHierarchyRangesOnBind()
                                     throws java.io.IOException,
                                            AutomationException

Indicates if the hierarchy ranges will be reset to the network dataset's hierarchy settings when the solver is bound.

Specified by:: isResetHierarchyRangesOnBind in interface INASolverSettings2

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

setResetHierarchyRangesOnBind

public void setResetHierarchyRangesOnBind(boolean value)
                                   throws java.io.IOException,
                                          AutomationException

Indicates if the hierarchy ranges will be reset to the network dataset's hierarchy settings when the solver is bound.

Specified by:: setResetHierarchyRangesOnBind in interface INASolverSettings2

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

getAttributeParameterValue

public java.lang.Object getAttributeParameterValue(java.lang.String attributeName,
                                                   java.lang.String paramName)
                                            throws java.io.IOException,
                                                   AutomationException

The value to use for an attribute parameter within the network dataset.

Specified by:: getAttributeParameterValue in interface INASolverSettings2

Parameters:: attributeName - The attributeName (in); paramName - The paramName (in)
Returns:: A Variant
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setAttributeParameterValue

public void setAttributeParameterValue(java.lang.String attributeName,
                                       java.lang.String paramName,
                                       java.lang.Object value)
                                throws java.io.IOException,
                                       AutomationException

The value to use for an attribute parameter within the network dataset.

Specified by:: setAttributeParameterValue in interface INASolverSettings2

Parameters:: attributeName - The attributeName (in); paramName - The paramName (in); value - A Variant (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getInternalODCostMatrixType

public int getInternalODCostMatrixType()
                                throws java.io.IOException,
                                       AutomationException

Indicates the type of internal matrix to be created.

Specified by:: getInternalODCostMatrixType in interface INAVRPSolver

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

setInternalODCostMatrixType

public void setInternalODCostMatrixType(int type)
                                 throws java.io.IOException,
                                        AutomationException

Indicates the type of internal matrix to be created.

Specified by:: setInternalODCostMatrixType in interface INAVRPSolver

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

isGenerateInternalRouteContext

public boolean isGenerateInternalRouteContext()
                                       throws java.io.IOException,
                                              AutomationException

Indicates if the internal route context should be generated.

Specified by:: isGenerateInternalRouteContext in interface INAVRPSolver

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

setGenerateInternalRouteContext

public void setGenerateInternalRouteContext(boolean value)
                                     throws java.io.IOException,
                                            AutomationException

Indicates if the internal route context should be generated.

Specified by:: setGenerateInternalRouteContext in interface INAVRPSolver

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

getExternalODCostMatrix

public INAODCostMatrix getExternalODCostMatrix()
                                        throws java.io.IOException,
                                               AutomationException

The external OD cost matrix object.

Specified by:: getExternalODCostMatrix in interface INAVRPSolver

Returns:: A reference to a com.esri.arcgis.networkanalyst.INAODCostMatrix
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setExternalODCostMatrixByRef

public void setExternalODCostMatrixByRef(INAODCostMatrix matrix)
                                  throws java.io.IOException,
                                         AutomationException

The external OD cost matrix object.

Specified by:: setExternalODCostMatrixByRef in interface INAVRPSolver

Parameters:: matrix - A reference to a com.esri.arcgis.networkanalyst.INAODCostMatrix (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getTimeFieldUnits

public int getTimeFieldUnits()
                      throws java.io.IOException,
                             AutomationException

The units for time fields in the NA classes.

Specified by:: getTimeFieldUnits in interface INAVRPSolver

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.

setTimeFieldUnits

public void setTimeFieldUnits(int units)
                       throws java.io.IOException,
                              AutomationException

The units for time fields in the NA classes.

Specified by:: setTimeFieldUnits in interface INAVRPSolver

Parameters:: units - 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.

getDistanceFieldUnits

public int getDistanceFieldUnits()
                          throws java.io.IOException,
                                 AutomationException

The units for distance fields in the NA classes.

Specified by:: getDistanceFieldUnits in interface INAVRPSolver

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.

setDistanceFieldUnits

public void setDistanceFieldUnits(int units)
                           throws java.io.IOException,
                                  AutomationException

The units for distance fields in the NA classes.

Specified by:: setDistanceFieldUnits in interface INAVRPSolver

Parameters:: units - 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.

getDefaultDate

public java.util.Date getDefaultDate()
                              throws java.io.IOException,
                                     AutomationException

The date to use for time windows without dates.

Specified by:: getDefaultDate in interface INAVRPSolver

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

setDefaultDate

public void setDefaultDate(java.util.Date date)
                    throws java.io.IOException,
                           AutomationException

The date to use for time windows without dates.

Specified by:: setDefaultDate in interface INAVRPSolver

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

getCapacityCount

public int getCapacityCount()
                     throws java.io.IOException,
                            AutomationException

The number of dimensions for object sizes.

Specified by:: getCapacityCount in interface INAVRPSolver

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

setCapacityCount

public void setCapacityCount(int value)
                      throws java.io.IOException,
                             AutomationException

The number of dimensions for object sizes.

Specified by:: setCapacityCount in interface INAVRPSolver

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

getTimeWindowViolationPenaltyFactor

public double getTimeWindowViolationPenaltyFactor()
                                           throws java.io.IOException,
                                                  AutomationException

The penalty factor for time window violation in the objective function.

Specified by:: getTimeWindowViolationPenaltyFactor in interface INAVRPSolver

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

setTimeWindowViolationPenaltyFactor

public void setTimeWindowViolationPenaltyFactor(double value)
                                         throws java.io.IOException,
                                                AutomationException

The penalty factor for time window violation in the objective function.

Specified by:: setTimeWindowViolationPenaltyFactor in interface INAVRPSolver

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

getExcessTransitTimePenaltyFactor

public double getExcessTransitTimePenaltyFactor()
                                         throws java.io.IOException,
                                                AutomationException

The penalty factor for excess transit time in the objective function.

Specified by:: getExcessTransitTimePenaltyFactor in interface INAVRPSolver

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

setExcessTransitTimePenaltyFactor

public void setExcessTransitTimePenaltyFactor(double value)
                                       throws java.io.IOException,
                                              AutomationException

The penalty factor for excess transit time in the objective function.

Specified by:: setExcessTransitTimePenaltyFactor in interface INAVRPSolver

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

getOutputLines

public int getOutputLines()
                   throws java.io.IOException,
                          AutomationException

Indicates how route lines are generated.

Specified by:: getOutputLines in interface INAVRPSolver

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

setOutputLines

public void setOutputLines(int value)
                    throws java.io.IOException,
                           AutomationException

Indicates how route lines are generated.

Specified by:: setOutputLines in interface INAVRPSolver

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

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:: serialize in interface IXMLSerialize

Parameters:: data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:: deserialize in interface IXMLSerialize

Parameters:: data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:: getClassID in interface IPersist

Parameters:: pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:: isDirty in interface IPersistStream

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

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:: load in interface IPersistStream

Parameters:: pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:: save in interface IPersistStream

Parameters:: pstm - A reference to a com.esri.arcgis.system.IStream (in); fClearDirty - The fClearDirty (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:: getSizeMax in interface IPersistStream

Parameters:: pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:: interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:: riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public java.lang.String getMinNamespaceSupported()
                                          throws java.io.IOException,
                                                 AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:: getMinNamespaceSupported in interface IXMLVersionSupport

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

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:: writeExternal in interface java.io.Externalizable

Throws:: java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:: readExternal in interface java.io.Externalizable

Throws:: java.io.IOException; java.lang.ClassNotFoundException

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.networkanalyst Class NAServerVRPParams

serialVersionUID

NAServerVRPParams

NAServerVRPParams

getClsid

equals

hashCode

getJintegraDispatch

release

setNALayerName

getNALayerName

setSnapTolerance

getSnapTolerance

setMaxSnapTolerance

getMaxSnapTolerance

setSnapToleranceUnits

getSnapToleranceUnits

setNAClassCandidateFieldMaps

getNAClassCandidateFieldMaps

setReturnMap

isReturnMap

setMapDescriptionByRef

getMapDescription

setImageDescriptionByRef

getImageDescription

setOutputSpatialReferenceByRef

getOutputSpatialReference

setReturnPartialResultsOnError

isReturnPartialResultsOnError

setSaveLayerOnServer

isSaveLayerOnServer

setLayerToken

getLayerToken

getTravelMode

setTravelMode

setOrdersByRef

getOrders

setDepotsByRef

getDepots

setRoutesByRef

getRoutes

setBreaksByRef

getBreaks

setRouteZonesByRef

getRouteZones

setRouteSeedPointsByRef

getRouteSeedPoints

setRouteRenewalsByRef

getRouteRenewals

setSpecialtiesByRef

getSpecialties

setOrderPairsByRef

getOrderPairs

setBarriersByRef

getBarriers

setPolylineBarriersByRef

getPolylineBarriers

setPolygonBarriersByRef

getPolygonBarriers

setReturnOrderPairs

isReturnOrderPairs

setReturnOrders

isReturnOrders

setReturnDepots

isReturnDepots

setReturnRoutes

isReturnRoutes

setReturnDepotVisits

isReturnDepotVisits

setReturnBreaks

isReturnBreaks

setReturnRouteRenewals

isReturnRouteRenewals

setReturnRouteSeedPoints

isReturnRouteSeedPoints

setReturnRouteZones

isReturnRouteZones

setReturnSpecialties

isReturnSpecialties

setReturnBarriers

com.esri.arcgis.networkanalyst
Class NAServerVRPParams