Packagecom.esri.bao.tasks.stdgeographies
Classpublic class StdGeographiesByAttributesParameters
InheritanceStdGeographiesByAttributesParameters Inheritance BAUtilityParameters Inheritance BABaseParameters Inheritance Object

The StdGeographiesByAttributesParameters class provides input parameters for the Standard Geographies by Attributes task.

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.

View the examples

See also

StdgeographiesByAttributesTask

Public Properties
 PropertyDefined By
 InheritedactiveDatasetID : String
Active dataset ID.
BAUtilityParameters
  geoLevelID : String
Community Analyst data layer ID to query features in.
StdGeographiesByAttributesParameters
 InheritedresultType : 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
 InheritedtaskName : String
[read-only] Name of a Business Analyst Server task associated with these parameters.
BABaseParameters
Public Methods
 MethodDefined 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
Property Detail
geoLevelIDproperty
geoLevelID:String

Community Analyst data layer ID to query features in. The list of available geography levels could be retrieved with GetStandardGeographyLevelsTask task.


Implementation
    public function get geoLevelID():String
    public function set geoLevelID(value:String):void

See also

GetStandardGeographyLevelsTask
searchStringproperty 
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.


Implementation
    public function get searchString():String
    public function set searchString(value:String):void
Constructor Detail
StdGeographiesByAttributesParameters()Constructor
public function StdGeographiesByAttributesParameters(geoLevelID:String = null, searchString:String = null)

Creates a new instance of the StdGeographiesByAttributesParameters class.

Parameters
geoLevelID:String (default = null) — Community Analyst data layer ID to query features in.
 
searchString:String (default = null) — Search string criterion.
Method Detail
toURLVariables()method
override public function toURLVariables():URLVariables

Converts task parameters to URL variables.

Returns
URLVariables
Examples
ActionScript to create StdGeographiesByAttributesParameters and then use in the StdGeographiesByAttributesTask: 
                     
     var parameters : StdGeographiesByAttributesParameters = new StdGeographiesByAttributesParameters();
     
     parameters.geoLevelID = "US.ZIP5";
     parameters.searchString = "Redlands";
     
     stdGeographiesByAttributesTask.execute(parameters, new Responder(resultHandler, faultHandler));



© 2011 Esri, Inc. All rights reserved.

Mon Dec 12 2011, 10:44 AM -08:00