| Package | com.esri.baserver.adapters |
| Class | public class BusinessSearchParameters |
| Inheritance | BusinessSearchParameters  Object |
| Since : | Business Analyst API for Flex 2.2. |
See also
| Property | Defined By | ||
|---|---|---|---|
| analysisExtent : Geometry
Spatial/geographic extent to filter search results with. | BusinessSearchParameters | ||
| businessTypeFilters : Array
An array of BusinessTypeFilter items restricting the search. | BusinessSearchParameters | ||
| featuresLimit : int
The limit of returned business points. | BusinessSearchParameters | ||
| locations : Array
Array of address locations to filter search results with. | BusinessSearchParameters | ||
| matchExactly : Boolean
True value of the parameter means the exact match of the string to search. | BusinessSearchParameters | ||
| outputSpatialReference : SpatialReference
The spatial reference to return the output feature set in. | BusinessSearchParameters | ||
| returnGeometry : Boolean
An option specifying the presence of the shape attribute in the returned record set. | BusinessSearchParameters | ||
| searchString : String
A string of characters which is used in the search query. | BusinessSearchParameters | ||
| studyArea : IStudyArea
Study area to filter search results with. | BusinessSearchParameters | ||
| useSimpleSearch : Boolean
True value of the parameter means a simple search (in company names only). | BusinessSearchParameters | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a new instance of the BusinessSearchParameters class. | BusinessSearchParameters | ||
| analysisExtent | property |
analysisExtent:GeometrySpatial/geographic extent to filter search results with. This parameter expects a value of the Extent or Polygon type.
The analysisExtent, studyArea, and locations
parameters are mutually exclusive. Only one of them could be specified.
public function get analysisExtent():Geometry public function set analysisExtent(value:Geometry):voidSee also
| businessTypeFilters | property |
businessTypeFilters:ArrayAn array of BusinessTypeFilter items restricting the search.
public function get businessTypeFilters():Array public function set businessTypeFilters(value:Array):voidSee also
| featuresLimit | property |
featuresLimit:intThe limit of returned business points.
public function get featuresLimit():int public function set featuresLimit(value:int):void| locations | property |
locations:ArrayArray of address locations to filter search results with. This array should contain String type items.
The analysisExtent, studyArea, and locations
parameters are mutually exclusive. Only one of them could be specified.
public function get locations():Array public function set locations(value:Array):void| matchExactly | property |
matchExactly:BooleanTrue value of the parameter means the exact match of the string to search.
The default value is false.
public function get matchExactly():Boolean public function set matchExactly(value:Boolean):void| 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| returnGeometry | property |
returnGeometry:BooleanAn option specifying the presence of the shape attribute in the returned record set.
The default value is true.
public function get returnGeometry():Boolean public function set returnGeometry(value:Boolean):void| searchString | property |
searchString:StringA string of characters which is used in the search query.
public function get searchString():String public function set searchString(value:String):void| studyArea | property |
studyArea:IStudyAreaStudy area to filter search results with.
The analysisExtent, studyArea, and locations
parameters are mutually exclusive. Only one of them could be specified.
public function get studyArea():IStudyArea public function set studyArea(value:IStudyArea):void| useSimpleSearch | property |
useSimpleSearch:BooleanTrue value of the parameter means a simple search (in company names only).
public function get useSimpleSearch():Boolean public function set useSimpleSearch(value:Boolean):void| BusinessSearchParameters | () | Constructor |
public function BusinessSearchParameters()Creates a new instance of the BusinessSearchParameters class.