| Package | com.esri.baserver.tasks.stdgeographies |
| Class | public class ReturnStdGeographyParameters |
| Inheritance | ReturnStdGeographyParameters  BAUtilityParameters BABaseParameters Object |
The geoLevelIDs parameter specifies IDs of the standard geography levels
to search geography features in.
The location point can be specified in one of three ways—by postal address, by geographic coordinates, and by ZIP code. All these ways are mutually exclusive.
address parameter specifies postal address fields.point parameter contains geographic coordinates of the map point.ZIP parameter specifies the location ZIP code. The centroid point of the given ZIP is used.Along with an individual point location, a point layer can be specified using the points parameter.
In this case, features matching to the given locations are combined together and the combined feature ID and Name
is returned for a geography level. The ID of a combined feature can be used in the geographyIDs parameter
of the StandardLayer and StandardLevelsOfGeographyParameters types.
All the ways for specifying geography locations are mutually exclusive. Only one parameter
from address, point, ZIP, and points should
be specified and others should be missing.
See also
| Property | Defined By | ||
|---|---|---|---|
 | activeDatasetID : String
Active dataset ID. | BAUtilityParameters | |
| address : Array
Postal address fields of the location requested. | ReturnStdGeographyParameters | ||
| geoLevelIDs : Array
Array containing IDs of standard geography levels to find geography features in (required). | ReturnStdGeographyParameters | ||
| point : MapPoint
Geographic coordinates of the location requested. | ReturnStdGeographyParameters | ||
| points : PointLayer
Point data layer specifying requested locations. | ReturnStdGeographyParameters | ||
| resultType : BAResultType [read-only]
Type of a result returned by the task associated with these parameters. | BABaseParameters | |
| taskName : String [read-only]
Name of a Business Analyst Server task associated with these parameters. | BABaseParameters | |
| ZIP : String
ZIP code of the location requested. | ReturnStdGeographyParameters | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a new instance of the ReturnStdGeographyParameters class. | ReturnStdGeographyParameters | ||
| address | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesaddress:ArrayPostal address fields of the location requested. This array should contain fields of the postal address, for example
["380 New York St.", "Redlands", "CA"]
public function get address():Array public function set address(value:Array):void| geoLevelIDs | property |
geoLevelIDs:ArrayArray containing IDs of standard geography levels to find geography features in (required). A list of available geography levels could be retrieved with the Get Standard Geography Levels task. This array should contain items of the String type.
public function get geoLevelIDs():Array public function set geoLevelIDs(value:Array):voidSee also
| point | property |
point:MapPointGeographic coordinates of the location requested.
public function get point():MapPoint public function set point(value:MapPoint):void| points | property |
points:PointLayerPoint data layer specifying requested locations.
public function get points():PointLayer public function set points(value:PointLayer):void| ZIP | property |
ZIP:StringZIP code of the location requested. The centroid point of the requested ZIP area is used.
public function get ZIP():String public function set ZIP(value:String):void| ReturnStdGeographyParameters | () | Constructor |
public function ReturnStdGeographyParameters()Creates a new instance of the ReturnStdGeographyParameters class.
var parameters : ReturnStdGeographyParameters = new ReturnStdGeographyParameters();
// Set standard geography levels to find geography features in.
parameters.geoLevelIDs = ["US.Counties"];
// Set address location fields.
parameters.address = ["8103 Sandy Spring Rd.", "Laurel", "MD", "20707"];
returnStdGeographyTask.execute(parameters, new Responder(resultHandler, faultHandler));