Esri Business Analyst Server API for Silverlight 2.2 Reference
SelectLocationsTask Class
Members  Example  See Also  Send Feedback
ESRI.ArcGIS.Client.BAServer.Tasks.BusinessesSearch Namespace : SelectLocationsTask Class

Glossary Item Box

The Select Locations task returns business locations matching the given search criteria.

Object Model

SelectLocationsTask ClassAbstractClient ClassITokenProvider Interface

Syntax

Remarks

A business location is specified with a list of names of sites of standard geography levels. For USA, a business location is identified with sites from 3 geography levels—US.States, US.Counties, and US.ZIP5. The geographyLevelsFilter parameter specifies an array of search criteria whose number is equal to the number of geography levels identifying a business location and whose order is from top to bottom. For example, the geography levels filter for USA should contain 3 strings for search in State abbreviation, County name, and ZIP5 code fields of business locations. The wildcard * can be substituted instead of any search string. It means that the corresponding field of a business location is ignored in the search.

Example Description
{ "CA", "Redlands", "92373" } Searches for State field containing "CA", County field containing "Redlands", and ZIP5 field containing "92373" substring.
{ "CA", "Red", "*" } Searches for State field containing "CA" and County field containing "Red" substring. ZIP5 field value is any.
{ "CA", "*", "9237" } Searches for State field containing "CA" and ZIP5 field containing "9237" substring. County field value is any.
{ "*", "Red", "*" } Searches for County field containing "Red" substring. State and ZIP5 field values are any.
{ "*", "*", "*" } Returns all available business locations.

NOTE 1: The search is case insensitive.

NOTE 2: Do not use the wildcard symbol * together with ordinary symbols in one search criterion. In this case, the wildcard symbol will be interpreted as an ordinary symbol and an empty table of business locations will be returned.

The result of this task is a FeatureSet object containing attributes of business locations selected.

Example

The code snippet below executes a Select Locations task.
C#Copy Code
// Specify geography levels filter.
List<string> geographyLevelsFilter = new List<string>() { "CA", "Red", "*" };
 
selectLocationsTask.ExecuteAsync(geographyLevelsFilter, new AsyncResponder(resultHandler, faultHandler));

Inheritance Hierarchy

System.Object
   ESRI.ArcGIS.Client.BACore.Client.AbstractTask
      ESRI.ArcGIS.Client.BACore.Client.BATask<TResult,TEventArgs>
         ESRI.ArcGIS.Client.BAServer.Tasks.BAServerTask<TResult>
            ESRI.ArcGIS.Client.BAServer.Tasks.BusinessesSearch.SelectLocationsTask

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

© 2010-2012 Esri, Inc. All Rights Reserved.