| Package | com.esri.baserver.tasks.stdgeographies |
| Class | public class StdGeographiesByAttributesParameters |
| Inheritance | StdGeographiesByAttributesParameters  BAUtilityParameters BABaseParameters Object |
The geoLevelID parameter specifies ID of the standard geography level
to search geography features in.
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 the 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, all
locations of the standard geography level are returned.
| 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. |
| "," | Returns all locations of the standard geography level. |
See also
| Property | Defined By | ||
|---|---|---|---|
 | activeDatasetID : String
Active dataset ID. | BAUtilityParameters | |
| geoLevelID : String
ID of a standard geography level to find geography features in (required). | StdGeographiesByAttributesParameters | ||
| resultType : BAResultType [read-only]
Type of a result returned by the task associated with these parameters. | BABaseParameters | |
| searchString : String
A string to search IDs and names of geography locations. | StdGeographiesByAttributesParameters | ||
| 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 StdGeographiesByAttributesParameters class. | StdGeographiesByAttributesParameters | ||
| geoLevelID | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesgeoLevelID:StringID of a standard geography level to find geography features in (required). The list of available geography levels could be retrieved with Get Standard Geography Levels task.
public function get geoLevelID():String public function set geoLevelID(value:String):voidSee also
| searchString | property |
searchString:StringA string to search IDs and names of geography locations.
public function get searchString():String public function set searchString(value:String):void| StdGeographiesByAttributesParameters | () | Constructor |
public function StdGeographiesByAttributesParameters()Creates a new instance of the StdGeographiesByAttributesParameters class.
var parameters : StdGeographiesByAttributesParameters = new StdGeographiesByAttributesParameters();
// Set a standard geography level.
parameters.geoLevelID = "US.States";
// Set a string to search in names of geography locations.
parameters.searchString = "ca,";
stdGeographiesByAttributesTask.execute(parameters, new Responder(resultHandler, faultHandler));