| Package | com.esri.baserver.tasks.customerstoresetup |
| Class | public class CustomerStoreSetupByGeocodeTableParameters |
| Inheritance | CustomerStoreSetupByGeocodeTableParameters  AnalysisParameters AnalysisParameters BATaskParameters Object |
Address information for Customer/Store Setup is specified with geocodeData parameter.
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 and
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 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. | CustomerStoreSetupByGeocodeTableParameters | ||
| geocodeCustomers : Boolean
An option specifying the setup type. | CustomerStoreSetupByGeocodeTableParameters | ||
| geocodeData : GeocodeData
Table containing address information for geocoding (required). | CustomerStoreSetupByGeocodeTableParameters | ||
| linkField : String
The name of field to be used for assigning customers with stores or trade areas
for Customer Setup. | CustomerStoreSetupByGeocodeTableParameters | ||
| nameField : String
Store/customer name field. | CustomerStoreSetupByGeocodeTableParameters | ||
| 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 | |
| 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 | |
| storeIDField : String
Store ID field name for Store Setup (required). | CustomerStoreSetupByGeocodeTableParameters | ||
| taskName : String [read-only]
Name of a Community Analyst Task associated with these parameters. | BATaskParameters | |
| Method | Defined By | ||
|---|---|---|---|
CustomerStoreSetupByGeocodeTableParameters(outputTypes:OutputTypes = null)
Creates a new instance of the CustomerStoreSetupByGeocodeTableParameters class. | CustomerStoreSetupByGeocodeTableParameters | ||
| 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| 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| geocodeData | property |
geocodeData:GeocodeDataTable containing address information for geocoding (required).
public function get geocodeData():GeocodeData public function set geocodeData(value:GeocodeData):void| linkField | property |
linkField:StringThe name of 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| nameField | property |
nameField:StringStore/customer name field.
public function get nameField():String public function set nameField(value:String):void| storeIDField | property |
storeIDField:StringStore ID field name for Store Setup (required).
public function get storeIDField():String public function set storeIDField(value:String):void| CustomerStoreSetupByGeocodeTableParameters | () | Constructor |
public function CustomerStoreSetupByGeocodeTableParameters(outputTypes:OutputTypes = null)Creates a new instance of the CustomerStoreSetupByGeocodeTableParameters class.
ParametersoutputTypes:OutputTypes (default = null) |
var parameters : CustomerStoreSetupByGeocodeTableParameters = new CustomerStoreSetupByGeocodeTableParameters();
// The GeocodeData type is an address information for geocoding, e.g.
//var geocodeData : GeocodeData = new GeocodeData(new TableData(geocodeAddressesData));
parameters.geocodeData = geocodeData;
customerStoreSetupByGeocodeTableTask.execute(parameters, new Responder(resultHandler, faultHandler));