com.esri.drs.BatchValidationParameters

	Property	Defined By
		analysisArea : Polygon A polygon geometry that defines the validation extent.	BatchValidationParameters
		batchJobFileName : String Gets the uploaded batch job name.	BatchValidationParameters
		changedFeaturesOnly : Boolean Controls validation type on enterprise geodatabases.	BatchValidationParameters
		createdBy : String Gets the name of the web user that created the batch job schedule.	BatchValidationParameters
		cronExpression : String The cron expression for the batch validation.	BatchValidationParameters
		executionsEndDate : Date Gets or sets the ending date for a batch validation schedule.	BatchValidationParameters
		fileItemId : String Gets or sets the ID of the uploaded batch job.	BatchValidationParameters
		maxNumberOfExecutions : Number Gets or sets the maximum number of batch validation executions that can run.	BatchValidationParameters
		productionWorkspace : String Gets or sets the production workspace path.	BatchValidationParameters
		productionWorkspaceVersion : String Gets or sets the production workspace version in which the data will be validated.	BatchValidationParameters
		sessionString : String Gets or sets the ArcGIS Data Reviewer session.	BatchValidationParameters
		title : String Gets or sets the batch validation title.	BatchValidationParameters
		userName : String Gets or sets the user name under which records are written to the reviewer workspace.	BatchValidationParameters

Property Detail

analysisArea

property

analysisArea:Polygon

A polygon geometry that defines the validation extent. Features that intersect this area will be validated.

This property can be used as the source for data binding.

Implementation
public function get analysisArea():Polygon
public function set analysisArea(value:Polygon):void

See also

com.esri.ags.geometry.Polygon

Example

The following code creates a polygon that is used to define a processing area for a batch validation.

         
         var bvParams = new BatchValidationParameters();
         
         // create a new polygon
         var polygon:Polygon = new Polygon([[
                 new MapPoint(1557601,6618462),
                 new MapPoint(1594673,6618462),
                 new MapPoint(1594673,6595378),
                 new MapPoint(1557601,6595378)]], new SpatialReference(102100)); //web mercator
         
         // limit the processing area to this polygon
         bvParams.analysisArea = polygon;

batchJobFileName

property

batchJobFileName:String

Gets the uploaded batch job name. Ignored by the server if set.

This property can be used as the source for data binding.

Implementation
public function get batchJobFileName():String
public function set batchJobFileName(value:String):void

changedFeaturesOnly

property

changedFeaturesOnly:Boolean

Controls validation type on enterprise geodatabases. If true, validation is limited to features that have changed from a parent to the child version. Changes between versions include the following:

Features inserted in the child version but not the parent.
Features changed in the child version and unchanged in the parent.
Features changed in both child and parent versions.
Features changed in the child version and deleted in the parent.

The default value is false.

This property can be used as the source for data binding.

Implementation
public function get changedFeaturesOnly():Boolean
public function set changedFeaturesOnly(value:Boolean):void

createdBy

property

createdBy:String

Gets the name of the web user that created the batch job schedule. Ignored by the server if set.

This property can be used as the source for data binding.

Implementation
public function get createdBy():String
public function set createdBy(value:String):void

cronExpression

property

cronExpression:String

The cron expression for the batch validation. Cron expressions set to execute more frequently than once every 15 minutes are not supported.

This property can be used as the source for data binding.

Implementation
public function get cronExpression():String
public function set cronExpression(value:String):void

executionsEndDate

property

executionsEndDate:Date

Gets or sets the ending date for a batch validation schedule. Execution will not occur after this date. If both this property and maxNumberOfExecutions are set, the Batch Validation schedule will finish with whichever condition happens first.

This property can be used as the source for data binding.

Implementation
public function get executionsEndDate():Date
public function set executionsEndDate(value:Date):void

See also

maxNumberOfExecutions

fileItemId

property

fileItemId:String

Gets or sets the ID of the uploaded batch job. Batch validation requires a .rbj (batch job) file. You upload this file to ArcGIS for Server using the server's uploads functionality. Uploads returns an item ID. This ID is referenced during Batch Validation. See ArcGIS for Server REST API documentation for more information on uploads.

This property can be used as the source for data binding.

Implementation
public function get fileItemId():String
public function set fileItemId(value:String):void

maxNumberOfExecutions

property

maxNumberOfExecutions:Number

Gets or sets the maximum number of batch validation executions that can run.

If both this property and executionsEndDate are set, the Batch Validation schedule will finish with whichever condition happens first.

This property can be used as the source for data binding.

Implementation
public function get maxNumberOfExecutions():Number
public function set maxNumberOfExecutions(value:Number):void

See also

executionsEndDate

productionWorkspace

property

productionWorkspace:String

Gets or sets the production workspace path. This path must be accessible to ArcGIS Server.

This property can be used as the source for data binding.

Implementation
public function get productionWorkspace():String
public function set productionWorkspace(value:String):void

productionWorkspaceVersion

property

productionWorkspaceVersion:String

Gets or sets the production workspace version in which the data will be validated. Applies only if production workspace is specified and it is an enterprise geodatabase.

This property can be used as the source for data binding.

Implementation
public function get productionWorkspaceVersion():String
public function set productionWorkspaceVersion(value:String):void

sessionString

property

sessionString:String

Gets or sets the ArcGIS Data Reviewer session. The session must exist in the reviewer workspace. The session string must follow this format: Session [Session ID] : [Session Name], e.g. Session 1 : Editing Session.

This property can be used as the source for data binding.

Implementation
public function get sessionString():String
public function set sessionString(value:String):void

See also

ReviewerSession

title

property

title:String

Gets or sets the batch validation title.

This property can be used as the source for data binding.

Implementation
public function get title():String
public function set title(value:String):void

userName

property

userName:String

Gets or sets the user name under which records are written to the reviewer workspace.

This property can be used as the source for data binding.

Implementation
public function get userName():String
public function set userName(value:String):void

Mon Jan 5 2015, 12:14 PM -08:00

ArcGIS Data Reviewer API for Flex	All Packages \| All Classes \| Index \| Frames No Frames
BatchValidationParameters	Properties

Package	com.esri.drs
Class	public class BatchValidationParameters
Inheritance	BatchValidationParameters Object
Implements	flash.events.IEventDispatcher