Packagecom.esri.baserver.tasks.customerstoresetup
Classpublic class CreateRecordSetByAddressesParameters
InheritanceCreateRecordSetByAddressesParameters Inheritance BABaseParameters Inheritance Object
Implements IBAResultProcessor

The CreateRecordSetByAddressesParameters class provides input parameters for the Create Record Set by Addresses task. The folderType parameter specifies the record set type:

ValueDescription
FolderType.STORE_LAYERS means store records (the storeID property of a record specifies a record ID and the customerID property is ignored)
FolderType.CUSTOMER_LAYERS means customer records (the customerID property of a record specifies a record ID and the storeID property specifies an ID of associated store)

View the examples

See also

CreateRecordSetByAddressesTask


Public Properties
 PropertyDefined By
  folderType : FolderType
Type of record set to be created.
CreateRecordSetByAddressesParameters
  recordSetByAddressArray : Array
Array of RecordSetByAddress instances.
CreateRecordSetByAddressesParameters
 InheritedresultType : BAResultType
[read-only] Type of a result returned by the task associated with these parameters.
BABaseParameters
 InheritedtaskName : String
[read-only] Name of a Business Analyst Server task associated with these parameters.
BABaseParameters
Public Methods
 MethodDefined By
  
CreateRecordSetByAddressesParameters(records:Array = null, type:FolderType = null)
Creates a new instance of the CreateRecordSetByAddressesParameters class.
CreateRecordSetByAddressesParameters
Property Detail
folderTypeproperty
folderType:FolderType

Type of record set to be created. This parameter allows FolderType.STORE_LAYERS or FolderType.CUSTOMER_LAYERS value only.

The default value is FolderType.STORE_LAYERS.


Implementation
    public function get folderType():FolderType
    public function set folderType(value:FolderType):void
recordSetByAddressArrayproperty 
recordSetByAddressArray:Array

Array of RecordSetByAddress instances.


Implementation
    public function get recordSetByAddressArray():Array
    public function set recordSetByAddressArray(value:Array):void
Constructor Detail
CreateRecordSetByAddressesParameters()Constructor
public function CreateRecordSetByAddressesParameters(records:Array = null, type:FolderType = null)

Creates a new instance of the CreateRecordSetByAddressesParameters class. If the type parameter is omitted, the FolderType.STORE_LAYERS value is used.

Parameters
records:Array (default = null) — Array of RecordSetByAddress instances.
 
type:FolderType (default = null) — Type of record set to be created.
Examples
ActionScript to create CreateRecordSetByAddressesParameters and then use in a Create Record Set by Addresses task:
                     
     var parameters : CreateRecordSetByAddressesParameters = new CreateRecordSetByAddressesParameters();
     
     // Record set type is stores or customers. Stores is the default type.
     //parameters.folderType = FolderType.STORE_LAYERS;
     
     // RecordSetByAddress type specifies address parameters.
     var address : RecordSetByAddress = new RecordSetByAddress();
     
     address.storeID = "1";               // Store ID
     address.name = "Store 1";            // Store name
     address.state = "CA";                // State
     address.city = "Redlands";           // City
     address.address = "380 New york st"; // Address
     address.ZIP = "92373";               // ZIP 
     
     // Set an array of address records.            
     parameters.recordSetByAddressArray = [ address ];
     
     createRecordSetByAddressesTask.execute(parameters, new Responder(resultHandler, faultHandler));