Packagecom.esri.baserver
Classpublic final class BusinessesSearchMethod
InheritanceBusinessesSearchMethod Inheritance BaseEnum Inheritance Object

The BusinessesSearchMethod class provides an enumeration of methods to search for competitor's businesses closest to your businesses.

See also

LocatorReportParameters


Public Properties
 PropertyDefined By
  items : Array
[static] [read-only] Array of all items of this enumeration.
BusinessesSearchMethod
 Inheritedvalue : String
[read-only] Value of the enumeration item.
BaseEnum
Public Methods
 MethodDefined By
  
toEnumItem(value:String, defaultItem:BusinessesSearchMethod = null):BusinessesSearchMethod
[static] Converts a string value to the enumeration item.
BusinessesSearchMethod
 Inherited
toString():String
Gets the value of the enumeration item.
BaseEnum
Public Constants
 ConstantDefined By
  FIND_CLOSEST : BusinessesSearchMethod
[static] Select the given number of closest competitors.
BusinessesSearchMethod
  WITHIN_RANGE : BusinessesSearchMethod
[static] Select all competitors that fall within the given distance.
BusinessesSearchMethod
Property Detail
itemsproperty
items:Array  [read-only]

Array of all items of this enumeration.


Implementation
    public static function get items():Array
Method Detail
toEnumItem()method
public static function toEnumItem(value:String, defaultItem:BusinessesSearchMethod = null):BusinessesSearchMethod

Converts a string value to the enumeration item.

Parameters

value:String — String value of the enumeration.
 
defaultItem:BusinessesSearchMethod (default = null) — An enumeration value to be used if the value is not recognized.

Returns
BusinessesSearchMethod — An enumeration item or the default item.
Constant Detail
FIND_CLOSESTConstant
public static const FIND_CLOSEST:BusinessesSearchMethod

Select the given number of closest competitors.

WITHIN_RANGEConstant 
public static const WITHIN_RANGE:BusinessesSearchMethod

Select all competitors that fall within the given distance.