| Package | com.esri.baserver.tasks.customerstoresetup |
| Class | public class CustomerStoreSetupByCoordinatesParameters |
| Inheritance | CustomerStoreSetupByCoordinatesParameters  AnalysisParameters AnalysisParameters BATaskParameters Object |
Point data for Customer/Store Setup are specified by either the dataTable
or points parameters (these parameters are mutually exclusive).
In the first case, the names of fields specified by parameter of this task should
match the fields of the input data table, and the output layer will contain all
fields specified in the input data table. In the second case, the customer/store layer
will contain fields imported from PointRecord items.
The latitudeFieldName and longitudeFieldName parameters are
used for identifying coordinate fields in the input record set specified with
the dataTable object.
The geocodeCustomers parameter specifies the Setup type: the true value (default)
means Customer Setup and the false value means Store Setup.
For Customer Setup, the nameField and linkField parameters can
be specified. A new customer ID field is created.
For Store Setup, the storeIDField parameter should be specified when the
dataTable parameter is used. The nameField parameter can be specified.
The createNewIDField parameter specifies whether to create a new store ID field or not.
If its value is true, a new store ID field is added to the output layer with the name specified
by the storeIDField parameter. If this name already exists in the input fields,
it is slightly modified to be unique. For example, if the input data already contains
a field with a STORE_ID name and you try to create a new store ID field with the same name,
a new field with the STORE_ID_1 name will be created in the output layer.
Output options for this task include rendering an output image (outputTypes.getMapImage) and/or creating
a feature class for subsequent analysis (outputTypes.getFeatureClass).
If no output options are specified, the required output options are specified as follows.
If the renderingParameters parameter is specified, the image output is requested.
If the outputAnalysisItem parameter is specified, the output analysis feature class
will be stored in the repository. If both renderingParameters and
outputAnalysisItem parameters are missing, the feature class output is requested.
See also
| Property | Defined By | ||
|---|---|---|---|
 | activeDatasetID : String
Active dataset ID. | BATaskParameters | |
| createNewIDField : Boolean
An option specifying the use of an existing store ID field or creating a new store ID
field for Store Setup. | CustomerStoreSetupByCoordinatesParameters | ||
| dataTable : TableData
Data table containing a point record set. | CustomerStoreSetupByCoordinatesParameters | ||
| geocodeCustomers : Boolean
An option specifying the setup type. | CustomerStoreSetupByCoordinatesParameters | ||
| latitudeFieldName : String
Name of the latitude (y) field. | CustomerStoreSetupByCoordinatesParameters | ||
| linkField : String
The name of the field to be used for assigning customers with stores or trade areas
for Customer Setup. | CustomerStoreSetupByCoordinatesParameters | ||
| longitudeFieldName : String
Name of the longitude (x) field. | CustomerStoreSetupByCoordinatesParameters | ||
| nameField : String
Store/customer name field. | CustomerStoreSetupByCoordinatesParameters | ||
| outputAnalysisItem : FolderItem
Configuration options for storing the output feature class in the repository. | AnalysisParameters | |
| outputSpatialReference : SpatialReference
The spatial reference to return the output feature set in. | AnalysisParameters | |
| outputTypes : OutputTypes
Task output types. | BATaskParameters | |
| points : Array
Array of points specified with PointRecord instances. | CustomerStoreSetupByCoordinatesParameters | ||
| renderingParameters : RenderingParameters
Configuration options for rendering output to map image. | AnalysisParameters | |
| resultType : BAResultType [read-only]
Type of the result returned by the task associated with these parameters. | BATaskParameters | |
| returnGeometry : Boolean
An option specifying the presence of the shape attribute in the returned record set. | AnalysisParameters | |
| spatialReference : SpatialReference
A spatial reference. | CustomerStoreSetupByCoordinatesParameters | ||
| storeIDField : String
Store ID field name for Store Setup. | CustomerStoreSetupByCoordinatesParameters | ||
| taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters | |
| Method | Defined By | ||
|---|---|---|---|
CustomerStoreSetupByCoordinatesParameters(outputTypes:OutputTypes = null)
Creates a new instance of the CustomerStoreSetupByCoordinatesParameters class. | CustomerStoreSetupByCoordinatesParameters | ||
| createNewIDField | property |
Hide Inherited Public Properties
Show Inherited Public PropertiescreateNewIDField:BooleanAn option specifying the use of an existing store ID field or creating a new store ID field for Store Setup.
The default value is false.
public function get createNewIDField():Boolean public function set createNewIDField(value:Boolean):void| dataTable | property |
dataTable:TableDataData table containing a point record set.
public function get dataTable():TableData public function set dataTable(value:TableData):void| geocodeCustomers | property |
geocodeCustomers:BooleanAn option specifying the setup type.
The default value is true.
public function get geocodeCustomers():Boolean public function set geocodeCustomers(value:Boolean):void| latitudeFieldName | property |
latitudeFieldName:String
Name of the latitude (y) field.
This property is used if the dataTable property is specified.
The default value is "Latitide".
public function get latitudeFieldName():String public function set latitudeFieldName(value:String):void| linkField | property |
linkField:StringThe name of the field to be used for assigning customers with stores or trade areas for Customer Setup.
public function get linkField():String public function set linkField(value:String):void| longitudeFieldName | property |
longitudeFieldName:String
Name of the longitude (x) field.
This property is used if the dataTable property is specified.
The default value is "Longitude".
public function get longitudeFieldName():String public function set longitudeFieldName(value:String):void| nameField | property |
nameField:StringStore/customer name field.
public function get nameField():String public function set nameField(value:String):void| points | property |
points:ArrayArray of points specified with PointRecord instances.
public function get points():Array public function set points(value:Array):voidSee also
| spatialReference | property |
spatialReference:SpatialReferenceA spatial reference.
public function get spatialReference():SpatialReference public function set spatialReference(value:SpatialReference):voidSee also
| storeIDField | property |
storeIDField:String
Store ID field name for Store Setup.
This property is required if dataTable property is used.
public function get storeIDField():String public function set storeIDField(value:String):void| CustomerStoreSetupByCoordinatesParameters | () | Constructor |
public function CustomerStoreSetupByCoordinatesParameters(outputTypes:OutputTypes = null)Creates a new instance of the CustomerStoreSetupByCoordinatesParameters class.
ParametersoutputTypes:OutputTypes (default = null) |
var parameters : CustomerStoreSetupByCoordinatesParameters = new CustomerStoreSetupByCoordinatesParameters();
// points is an array of com.esri.bacore.PointRecord items, e.g.
//var points:Array = [new PointRecord("store_1", "Store 1", "1", 34.052074, -117.207841)];
parameters.points = points;
customerStoreSetupByCoordinatesTask.execute(parameters, new Responder(resultHandler, faultHandler));