| FRAMES | NO FRAMES |
Parameters of SelectLocations utility method.
Availability: Business Analyst Server 10.0.
class SelectLocationsParameters : AnalysisParameters
| Property | Description |
|---|---|
| GeographyLevelsFilter | Array of strings specifying criteria for search in address fields from top to bottom. Type String[]. |
| 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. 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. |
The GeographyLevelsFilter property specifies an array of search criteria with a number equal to the number of address fields identifying a business location and with an order from top to bottom. For example, the geography levels filter for USA should contain three strings for search in State abbreviation, City name, and ZIP 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 |
|---|---|
| new string[] { "CA", "Redlands", "92373" } | Searches for State field containing "CA", City field containing "Redlands", and ZIP5 field containing "92373" substring. |
| new string[] { "CA", "Red", "*" } | Searches for State field containing "CA" and City field containing "Red" substring. ZIP5 field value is any. |
| new string[] { "CA", "*", "9237" } | Searches for State field containing "CA" and ZIP5 field containing "9237" substring. City field value is any. |
| new string[] { "*", "Red", "*" } | Searches for City field containing "Red" substring. State and ZIP5 field values are any. |
| new string[] { "*", "*", "*" } | Returns all available business locations. |