| Package | com.esri.bao.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.
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.
See also
| Property | Defined By | ||
|---|---|---|---|
 | activeDatasetID : String
Active dataset ID. | BAUtilityParameters | |
| 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 [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| coordinates | property |
coordinates:ArrayGeographic 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.
public function get coordinates():Array public function set coordinates(value:Array):void| geoLevelIDs | property |
geoLevelIDs:ArrayArray 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.
public function get geoLevelIDs():Array public function set geoLevelIDs(value:Array):voidSee also
| 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();
// 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));