Package | com.esri.bao.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 specifies a string to search in IDs and names of geography features.
If this parameter is missing or empty, all features of the data layer are recognized as matching features and
will be returned.
See also
Property | Defined By | ||
---|---|---|---|
activeDatasetID : String
Active dataset ID. | BAUtilityParameters | ||
geoLevelID : String
Community Analyst data layer ID to query features in. | StdGeographiesByAttributesParameters | ||
resultType : BAResultType [read-only]
Type of a result returned by the task associated with these parameters. | BABaseParameters | ||
searchString : String
A string of characters which is used to query features of the data layer specified by the
geoLevelID parameter value. | StdGeographiesByAttributesParameters | ||
taskName : String [read-only]
Name of a Business Analyst Server task associated with these parameters. | BABaseParameters |
Method | Defined By | ||
---|---|---|---|
StdGeographiesByAttributesParameters(geoLevelID:String = null, searchString:String = null)
Creates a new instance of the StdGeographiesByAttributesParameters class. | StdGeographiesByAttributesParameters | ||
toURLVariables():URLVariables [override]
Converts task parameters to URL variables. | StdGeographiesByAttributesParameters |
geoLevelID | property |
geoLevelID:String
Community Analyst data layer ID to query features in. The list of available geography levels could be retrieved with GetStandardGeographyLevelsTask task.
public function get geoLevelID():String
public function set geoLevelID(value:String):void
See also
searchString | property |
searchString:String
A string of characters which is used to query features of the data layer specified by the geoLevelID parameter value.
A feature of the data layer is recognized as matching feature if its ID or name contains the search string. If the search string is missing or empty, all features of the data layer are recognized as matching features.
public function get searchString():String
public function set searchString(value:String):void
StdGeographiesByAttributesParameters | () | Constructor |
public function StdGeographiesByAttributesParameters(geoLevelID:String = null, searchString:String = null)
Creates a new instance of the StdGeographiesByAttributesParameters class.
ParametersgeoLevelID:String (default = null ) — Community Analyst data layer ID to query features in.
| |
searchString:String (default = null ) — Search string criterion.
|
toURLVariables | () | method |
override public function toURLVariables():URLVariables
Converts task parameters to URL variables.
ReturnsURLVariables |
var parameters : StdGeographiesByAttributesParameters = new StdGeographiesByAttributesParameters(); parameters.geoLevelID = "US.ZIP5"; parameters.searchString = "Redlands"; stdGeographiesByAttributesTask.execute(parameters, new Responder(resultHandler, faultHandler));