| Package | com.esri.baserver.tasks.stdgeographies |
| Class | public class StdGeographiesListParameters |
| Inheritance | StdGeographiesListParameters  BAUtilityParameters BABaseParameters Object |
The search criterion is specified with either the analysisExtent or
searchString parameter values. If both parameters are missing, ID and Name attributes
of all standard geography levels are returned.
If the analysisExtent parameter is specified, the spatialRelationship
parameter specifies a way for selection of matching features which fall in this extent.
The searchString parameter can contain up to two comma-separated substrings.
The first substring specifies the criterion for search in the locations' name field and the last
substring specifies the criterion for search in locations' ID field. If the second string
is omitted together with a delimiting comma, the search is applied to both location names and IDs
with the same search criterion. The search is applied using the logical "or" operation: a location
matches the search criterion if either its name contains the name search substring or its ID
contains the ID search substring. The case of an empty name or ID search substring means
skipping the search by name or ID, respectively. If both substrings are empty, any location
of the standard geography level matches the search criteria.
| Example | Description |
|---|---|
| "San,123" | Searches location name containing "San" substring or location ID containing "123" substring. |
| "123" | Searches location name containing "123" substring or location ID containing "123" substring. |
| ",123" | Searches location ID containing "123" substring. |
| "San," | Searches location name containing "San" substring. |
| "," | Searches any location of the standard geography level. |
See also
| Property | Defined By | ||
|---|---|---|---|
 | activeDatasetID : String
Active dataset ID. | BAUtilityParameters | |
| analysisExtent : Geometry
Spatial/geographic extent on which to perform the search. | StdGeographiesListParameters | ||
| resultType : BAResultType [read-only]
Type of a result returned by the task associated with these parameters. | BABaseParameters | |
| searchString : String
A string to search in names and IDs of geography locations. | StdGeographiesListParameters | ||
| spatialRelationship : SpatialRelEnum
The spatial selection method used with the analysisExtent to define the area of analysis. | StdGeographiesListParameters | ||
| taskName : String [read-only]
Name of a Business Analyst Server task associated with these parameters. | BABaseParameters | |
| Method | Defined By | ||
|---|---|---|---|
Creates a new instance of the StdGeographiesListParameters class. | StdGeographiesListParameters | ||
| analysisExtent | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesanalysisExtent:GeometrySpatial/geographic extent on which to perform the search. This parameter expects a value of the Extent or Polygon type.
public function get analysisExtent():Geometry public function set analysisExtent(value:Geometry):voidSee also
| searchString | property |
searchString:StringA string to search in names and IDs of geography locations.
public function get searchString():String public function set searchString(value:String):void| spatialRelationship | property |
spatialRelationship:SpatialRelEnum
The spatial selection method used with the analysisExtent to define the area of analysis.
The default value is SpatialRelEnum.INTERSECTS.
public function get spatialRelationship():SpatialRelEnum public function set spatialRelationship(value:SpatialRelEnum):void| StdGeographiesListParameters | () | Constructor |
public function StdGeographiesListParameters()Creates a new instance of the StdGeographiesListParameters class.
var parameters : StdGeographiesListParameters = new StdGeographiesListParameters();
// Set a data extent for analysis to myExtent that is a value of the Extent or Polygon type.
parameters.analysisExtent = myExtent;
stdGeographiesListTask.execute(parameters, new Responder(resultHandler, faultHandler));