FRAMES | NO FRAMES
SelectBusinessesParameters Type

Parameters of SelectBusinesses utility method.

Availability: Business Analyst Server 10.0.

class SelectBusinessesParameters : AnalysisParameters

Property Description
BusinessTypeFilters (optional) Array of business type filters restricting the search. Type BusinessTypeFilter[].
FeaturesLimit (optional) The limit of returned business points. Type Int32.
Default: 1000.
MatchExactly (optional) True value means the exact match of the string to search. Type Boolean.
Default: false.
SearchString (optional) A string of characters which is used in the search query. Type String.
SpatialFilter (optional) A spatial filter restricting the search. Type SpatialFilter.
UseSimpleSearch (optional) True value means a simple search (e.g., in company names only). Type Boolean.
Default: false.
ActiveDatasetID ID of the active dataset. Type String. Inherited from AnalysisParameters.
IsFullErrorMessage Mode for composing error messages. Type Boolean. Inherited from AnalysisParameters.
OutputSpatialReference An option specifying the spatial reference to return the output feature layer in. Type SpatialReference. If this parameter is missing, the output record set will be returned in the default spatial reference. Available with Business Analyst Server 10.0 SP1. Inherited from AnalysisParameters.
ReturnGeometry An option specifying the presence of the shape attribute in the returned record set. Type Boolean. Available with Business Analyst Server 10.0 SP1. Inherited from AnalysisParameters.
Default: true.

Remarks

Business points can be selected using any combination of three search criteria—a search string criterion, a spatial filter, and business type filters. A business point will be selected if it matches all search criteria specified.

The search string criterion is specified with the SearchString property. Its value is searched in textual attribute fields of a business point record using the following rules:

Example Description
"Fireproofing" Searches for a single "FIREPROOFING" word.
"Burger King" Searches for both "BURGER" and "KING" words.
"Burger;King" Searches for "BURGER" or "KING" word.
"\"Burger King\"" Searches for "BURGER KING" phrase.
"Don*" Searches for a word starting with "DON".
"*Don" Searches for a word ending with "DON".
"Don*ld" Searches for a word starting with "DON" and ending with "LD".
"\"Burger King\";\"Mc Donald\"" Searches for "BURGER KING" or "MC DONALD" phrase.

The spatial filter is specified with the SpatialFilter property of the SpatialFilter type. It restricts the search in one of three possible ways—by specifying either an analysis extent, a boundary layer, or a list of business locations.

The business type filters are specified with the BusinessTypeFilters property. This property contains a list of business type filters of the BusinessTypeFilter type to be subsequently applied to selected business points. For USA, either the NAICS or SIC filter is useful as a business type filter. If both filters are specified in the BusinessTypeFilters property value, selected business points will match both of them.

See Also