| Package | com.esri.bao.tasks.geofence |
| Class | public class GeofenceInfoParameters |
| Inheritance | GeofenceInfoParameters  AnalysisParameters BATaskParameters Object |
| Implements | IBAResultProcessor |
The standard geography data layer is specified by the geoLevelID property value.
The query criteria is specified by the searchString property value.
This query is performed on the name and ID attributes of every available feature in the standard geography layer.
All available features in the specified standard geography layer are requested when no value for the
searchString property is specified.
When specifying the request with a Community Analyst API user account with geofence constraints, the resulting features are filtered with geofence criteria.
Output options for this task include creating a feature class for subsequent analysis (outputTypes.getFeatureClass) and rendering output image (outputTypes.getMapImage). If output options are not specified, the output will contain the stdGeographiesFeatures only.
See also
| Property | Defined By | ||
|---|---|---|---|
 | activeDatasetID : String
Active dataset ID. | BATaskParameters | |
| geoLevelID : String
Community Analyst data layer ID to query features in. | GeofenceInfoParameters | ||
| outputSpatialReference : SpatialReference
The spatial reference to return the output feature set in. | GeofenceInfoParameters | ||
| outputTypes : OutputTypes
Task output types. | BATaskParameters | |
| resultType : BAResultType [override] [read-only]
Type of a result returned by the task associated with these parameters. | GeofenceInfoParameters | ||
| searchString : String
A string of characters which is used to query features of the data layer specified by the
geoLevelID parameter value. | GeofenceInfoParameters | ||
| taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters | |
| Method | Defined By | ||
|---|---|---|---|
GeofenceInfoParameters(geoLevelID:String = null, searchString:String = null)
Creates a new instance of the GeofenceInfoParameters class. | GeofenceInfoParameters | ||
| geoLevelID | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesgeoLevelID:StringCommunity 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):voidSee also
| outputSpatialReference | property |
outputSpatialReference:SpatialReferenceThe spatial reference to return the output feature set in.
public function get outputSpatialReference():SpatialReference public function set outputSpatialReference(value:SpatialReference):void| resultType | property |
resultType:BAResultType [read-only] [override] Type of a result returned by the task associated with these parameters. The base implementation returns BAResultType.SPECIAL.
public function get resultType():BAResultType| searchString | property |
searchString:StringA 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 a 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| GeofenceInfoParameters | () | Constructor |
public function GeofenceInfoParameters(geoLevelID:String = null, searchString:String = null)Creates a new instance of the GeofenceInfoParameters class.
ParametersgeoLevelID:String (default = null) | |
searchString:String (default = null) |
See also
var parameters : GeofenceInfoParameters = new GeofenceInfoParameters();
parameters.geoLevelID = "US.ZIP5";
parameters.searchString = "923";
// Optionally set getFeatureClass and getMapImage to true
parameters.outputTypes.getFeatureClass = true;
parameters.outputTypes.getMapImage = true;
geofenceInfoTask.execute(parameters, new Responder(resultHandler, faultHandler));