| Package | com.esri.bao.tasks.stdgeographies |
| Class | public final class ReturnStdGeographyParameters |
| Inheritance | ReturnStdGeographyParameters  BAUtilityParameters |
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.
The address parameter specifies postal address fields.
The coordinates array contains geographic coordinates of the point
(latitude and longitude).
The ZIP parameter specifies the location ZIP code. The centroid point of the given ZIP is used.
var parameters : ReturnStdGeographyParameters = new ReturnStdGeographyParameters();
// Multiple standard geography layers can be specified in this array.
parameters.geoLevelIDs = ["US.Counties","US.States"];
// One and only one of the three locations need be specified - address, coordinates or zip.
parameters.address = ["380 New York St.", "Redlands", "CA"];
//parameters.coordinates = [mapPoint.x, mapPoint.y];
//parameters.ZIP = "92373";
returnStdGeographyTask.execute(parameters, new Responder(resultHandler, faultHandler));
See also
| Property | Defined by | ||
|---|---|---|---|
| address : Array
Postal address fields of the location requested.
| ReturnStdGeographyParameters | ||
| coordinates : Array
Geographic coordinates of the location requested.
| ReturnStdGeographyParameters | ||
| geoLevelIDs : Array
Array containing IDs of standard geography levels to find geography features in (required).
| ReturnStdGeographyParameters | ||
 | resultType : BAResultType
Type of a result returned by the task associated with these parameters.
| BAUtilityParameters | |
| taskName : String
Name of a Business Analyst task associated with these parameters.
| BAUtilityParameters | |
| 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:Array [read-write]Postal address fields of the location requested. This array should contain fields of the postal address, for example
["380 New York St.", "Redlands", "CA"]
Implementation public function get address():Array
public function set address(value:Array):void
| coordinates | property |
coordinates:Array [read-write]Geographic coordinates of the location requested. This array should contain two numeric values specifying first the longitude (x) coordinate and then the latitude (y) coordinate of point.
Implementation public function get coordinates():Array
public function set coordinates(value:Array):void
| geoLevelIDs | property |
geoLevelIDs:Array [read-write]Array containing IDs of standard geography levels to find geography features in (required). The list of available geography levels could be retrieved with the Get Standard Geography Levels task. This array should contain items of the String type.
Implementation public function get geoLevelIDs():Array
public function set geoLevelIDs(value:Array):void
See also
| ZIP | property |
ZIP:String [read-write]ZIP code of the location requested. The centroid point of the requested ZIP area is used.
Implementation 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.