| Package | com.esri.drs |
| Class | public class BatchValidationTask |
| Inheritance | BatchValidationTask  DRSBaseTask com.esri.ags.tasks.BaseTask |
Batch Validation operates in two execution modes: adhoc (immediate); scheduled.
Adhoc jobs execute immediately and run once. Scheduled jobs run repeatedly according
to a schedule and terminate once BatchValidationParameters.maxNumberOfExecutions
has been exceeded or BatchValidationParameters.executionEndDate has passed.
See also
| Property | Defined By | ||
|---|---|---|---|
 | createReviewerSessionLastResult : ReviewerSession
ReviewerSession returned from last call to the createReviewerSession function. | DRSBaseTask | |
| executeJobLastResult : String
Adhoc job ID returned from the last call to the executeJob function. | BatchValidationTask | ||
| getAdhocJobsListLastResult : Array
Array of adhoc BatchValidationJobDetails instances return from the last call to the getAdhocJobsList function. | BatchValidationTask | ||
| getJobDetailsLastResult : BatchValidationJobDetails
BatchValidationJobDetails instance returned from the last call to the getJobDetails function. | BatchValidationTask | ||
| getJobExecutionDetailsLastResult : BatchValidationJobExecutionDetails
BatchValidationJobExecutionDetails instance returned from the last call to the getJobExecutionDetails function. | BatchValidationTask | ||
| getJobIdsLastResult : Object
Object returned from the last call to the getJobIds function. | BatchValidationTask | ||
| getLifecycleStatusStringsLastResult : Array
Array of lifecycle status strings returned from last call to the getLifecycleStatusStrings function. | DRSBaseTask | |
| getReviewerSessionsLastResult : Array
Array of ReviewerSession object returned from last call to the getReviewerSessions function. | DRSBaseTask | |
| getScheduledJobsListLastResult : Array
Array of scheduled BatchValidationJobDetails instances return from the last call to the getScheduledJobsList function. | BatchValidationTask | ||
| scheduleJobLastResult : String
Scheduled job ID returned from the last call to the scheduleJob function. | BatchValidationTask | ||
| Method | Defined By | ||
|---|---|---|---|
BatchValidationTask(url:String = null)
Constructor
| BatchValidationTask | ||
cancelJobExecution(jobId:String, responder:IResponder = null):AsyncToken
Cancels a job that is currently executing. | BatchValidationTask | ||
| createReviewerSession(sessionName:String, sessionProperties:SessionProperties, responder:IResponder = null):AsyncToken
Creates a new Reviewer Session. | DRSBaseTask | |
deleteJob(jobId:String, responder:IResponder = null):AsyncToken
Deletes an existing scheduled Batch Validation Job. | BatchValidationTask | ||
disableJob(jobId:String, responder:IResponder = null):AsyncToken
Pauses an existing Batch Validation Job's schedule. | BatchValidationTask | ||
editJob(jobId:String, parameters:BatchValidationParameters, responder:IResponder = null):AsyncToken
Edits the schedule, settings and title of an existing Batch Validation Job. | BatchValidationTask | ||
enableJob(jobId:String, responder:IResponder = null):AsyncToken
Restarts an existing Batch Validation Job's schedule. | BatchValidationTask | ||
executeJob(parameters:BatchValidationParameters, responder:IResponder = null):AsyncToken
Executes an adhoc job. | BatchValidationTask | ||
getAdhocJobsList(responder:IResponder = null):AsyncToken
Retrieves all adhoc jobs from the server and returns an array of
BatchValidationJobDetails with the information. | BatchValidationTask | ||
getJobDetails(jobId:String, responder:IResponder = null):AsyncToken
Fetches Batch Validation Job details. | BatchValidationTask | ||
getJobExecutionDetails(jobId:String, responder:IResponder = null):AsyncToken
Fetches the job execution details of a Batch Validation Job. | BatchValidationTask | ||
getJobIds(responder:IResponder = null):AsyncToken
Returns an object that contains Scheduled and AdhocJob IDs in two separate arrays. | BatchValidationTask | ||
| getLifecycleStatusStrings(responder:IResponder = null):AsyncToken
Retrieves a list of localized lifecycle status strings from the reviewer workspace. | DRSBaseTask | |
| getReviewerSessions(responder:IResponder = null):AsyncToken
Returns an array of sessions in a Reviewer workspace. | DRSBaseTask | |
getScheduledJobsList(responder:IResponder = null):AsyncToken
Retrieves all scheduled jobs from the server and returns an array of
BatchValidationJobDetails with the information. | BatchValidationTask | ||
scheduleJob(parameters:BatchValidationParameters, responder:IResponder = null):AsyncToken
Schedules a new Batch Validation. | BatchValidationTask | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when cancelJobExecution operation successfully completes. | BatchValidationTask | |||
| Dispatched when createReviewerSession operation successfully completes. | DRSBaseTask | ||
| Dispatched when deleteJob operation completes. | BatchValidationTask | |||
| Dispatched when disableJob operation successfully completes. | BatchValidationTask | |||
| Dispatched when editJob operation completes. | BatchValidationTask | |||
| Dispatched when enableJob operation completes. | BatchValidationTask | |||
| Dispatched when executeJob operation successfully completes. | BatchValidationTask | |||
| Dispatched when there is a problem accessing the Reviewer Map Server. | BatchValidationTask | |||
| Dispatched when getAdhocJobsList operation successfully completes. | BatchValidationTask | |||
| Dispatched when getJobDetails operation successfully completes. | BatchValidationTask | |||
| Dispatched when getJobExecutionDetails operation successfully completes. | BatchValidationTask | |||
| Dispatched when getJobIds operation successfully completes. | BatchValidationTask | |||
| Dispatched when getLifecycleStatusStrings operation successfully completes. | DRSBaseTask | ||
| Dispatched when getReviewerSessions operation successfully completes. | DRSBaseTask | ||
| Dispatched when getScheduledJobsList operation successfully completes. | BatchValidationTask | |||
| Dispatched when scheduleJob operation successfully completes. | BatchValidationTask | |||
| executeJobLastResult | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesexecuteJobLastResult:StringAdhoc job ID returned from the last call to the executeJob function.
This property can be used as the source for data binding.
public function get executeJobLastResult():String public function set executeJobLastResult(value:String):voidSee also
| getAdhocJobsListLastResult | property |
getAdhocJobsListLastResult:ArrayArray of adhoc BatchValidationJobDetails instances return from the last call to the getAdhocJobsList function.
This property can be used as the source for data binding.
public function get getAdhocJobsListLastResult():Array public function set getAdhocJobsListLastResult(value:Array):voidSee also
| getJobDetailsLastResult | property |
getJobDetailsLastResult:BatchValidationJobDetailsBatchValidationJobDetails instance returned from the last call to the getJobDetails function.
This property can be used as the source for data binding.
public function get getJobDetailsLastResult():BatchValidationJobDetails public function set getJobDetailsLastResult(value:BatchValidationJobDetails):voidSee also
| getJobExecutionDetailsLastResult | property |
getJobExecutionDetailsLastResult:BatchValidationJobExecutionDetailsBatchValidationJobExecutionDetails instance returned from the last call to the getJobExecutionDetails function.
This property can be used as the source for data binding.
public function get getJobExecutionDetailsLastResult():BatchValidationJobExecutionDetails public function set getJobExecutionDetailsLastResult(value:BatchValidationJobExecutionDetails):voidSee also
| getJobIdsLastResult | property |
getJobIdsLastResult:Object
Object returned from the last call to the getJobIds function.
The object holds two string arrays, adhocJobs and scheduledJobs, with the job IDs.
This property can be used as the source for data binding.
public function get getJobIdsLastResult():Object public function set getJobIdsLastResult(value:Object):voidSee also
{
"scheduledJobs": ["ae116971-ade6-41e8-97e9-3bce74524dc9", "35b26ff5-ebc0-436d-8ddd-af9fadd624f1"],
"adhocJobs": ["e604cc76-bf5a-4bd0-b497-85bf7f676aed"]
}
| getScheduledJobsListLastResult | property |
getScheduledJobsListLastResult:ArrayArray of scheduled BatchValidationJobDetails instances return from the last call to the getScheduledJobsList function.
This property can be used as the source for data binding.
public function get getScheduledJobsListLastResult():Array public function set getScheduledJobsListLastResult(value:Array):voidSee also
| scheduleJobLastResult | property |
scheduleJobLastResult:StringScheduled job ID returned from the last call to the scheduleJob function.
This property can be used as the source for data binding.
public function get scheduleJobLastResult():String public function set scheduleJobLastResult(value:String):voidSee also
| BatchValidationTask | () | Constructor |
public function BatchValidationTask(url:String = null)Constructor
Parametersurl:String (default = null) |
var bvUrl:String = "http://localhost:6080/arcgis/rest/services/reviewer/MapServer/exts/DataReviewerServer";
var task:BatchValidationTask = new BatchValidationTask(bvUrl);
| cancelJobExecution | () | method |
public function cancelJobExecution(jobId:String, responder:IResponder = null):AsyncTokenCancels a job that is currently executing. On completion the cancelJobExecutionComplete event is fired and the optional responder is called. Event result holds a boolean that indicates if cancel succeeded or not.
Parameters
jobId:String — Job Id of the batch validation job to cancel.
| |
responder:IResponder (default = null) |
AsyncToken |
See also
| deleteJob | () | method |
public function deleteJob(jobId:String, responder:IResponder = null):AsyncTokenDeletes an existing scheduled Batch Validation Job. On completion the deleteJobComplete event is fired and the optional responder is called. Event result holds a boolean that indicates if the deleteJob function succeeded or not.
Parameters
jobId:String — Job Id of the batch validation job to delete.
| |
responder:IResponder (default = null) |
AsyncToken |
See also
| disableJob | () | method |
public function disableJob(jobId:String, responder:IResponder = null):AsyncTokenPauses an existing Batch Validation Job's schedule. On completion the disableJobComplete event is fired and the optional responder is called. Event result holds a boolean that indicates if the disableJob function succeeded or not.
Parameters
jobId:String — Job Id of the batch validation job to be disabled.
| |
responder:IResponder (default = null) |
AsyncToken |
See also
| editJob | () | method |
public function editJob(jobId:String, parameters:BatchValidationParameters, responder:IResponder = null):AsyncTokenEdits the schedule, settings and title of an existing Batch Validation Job. On completion the editJobComplete event is fired and the optional responder is called. Event result contains a boolean that indicates if the editJob function succeeded or not.
Parameters
jobId:String — JobID of the job to edit.
| |
parameters:BatchValidationParameters — Parameters to change in an existing batch job.
| |
responder:IResponder (default = null) |
AsyncToken |
See also
| enableJob | () | method |
public function enableJob(jobId:String, responder:IResponder = null):AsyncTokenRestarts an existing Batch Validation Job's schedule. Use enableJob to restart a previously disabled job. On completion the enableJobComplete event is fired and the optional responder is called. Event result contains a boolean that indicates if the enableJob function succeeded or not.
Parameters
jobId:String — Job Id of the batch validation job to enable.
| |
responder:IResponder (default = null) |
AsyncToken |
See also
| executeJob | () | method |
public function executeJob(parameters:BatchValidationParameters, responder:IResponder = null):AsyncTokenExecutes an adhoc job. Adhoc jobs execute immediately and run once. On completion the executeJobComplete event is fired and the optional responder is called.
Parameters
parameters:BatchValidationParameters — Parameters specifying the details of a job to execute.
| |
responder:IResponder (default = null) |
AsyncToken |
See also
| getAdhocJobsList | () | method |
public function getAdhocJobsList(responder:IResponder = null):AsyncTokenRetrieves all adhoc jobs from the server and returns an array of BatchValidationJobDetails with the information. On completion the getAdhocJobsListComplete event is fired and the optional responder is called.
Parameters
responder:IResponder (default = null) |
AsyncToken |
See also
| getJobDetails | () | method |
public function getJobDetails(jobId:String, responder:IResponder = null):AsyncTokenFetches Batch Validation Job details. On completion the getJobDetailsComplete event is fired and the optional responder is called.
Parameters
jobId:String — Job Id of the batch validation job.
| |
responder:IResponder (default = null) |
AsyncToken |
See also
| getJobExecutionDetails | () | method |
public function getJobExecutionDetails(jobId:String, responder:IResponder = null):AsyncTokenFetches the job execution details of a Batch Validation Job. On completion the getJobExecutionDetailsComplete event is fired and the optional responder is called.
Parameters
jobId:String — Job Id of the batch validation job.
| |
responder:IResponder (default = null) |
AsyncToken |
See also
| getJobIds | () | method |
public function getJobIds(responder:IResponder = null):AsyncTokenReturns an object that contains Scheduled and AdhocJob IDs in two separate arrays. On completion the getJobDetailsComplete event is fired and the optional responder is called.
Parameters
responder:IResponder (default = null) |
AsyncToken |
See also
| getScheduledJobsList | () | method |
public function getScheduledJobsList(responder:IResponder = null):AsyncTokenRetrieves all scheduled jobs from the server and returns an array of BatchValidationJobDetails with the information. On completion the getScheduledJobsListComplete event is fired and the optional responder is called.
Parameters
responder:IResponder (default = null) |
AsyncToken |
See also
| scheduleJob | () | method |
public function scheduleJob(parameters:BatchValidationParameters, responder:IResponder = null):AsyncTokenSchedules a new Batch Validation. On completion the scheduleJobComplete event is fired and the optional responder is called.
Parameters
parameters:BatchValidationParameters — Parameters for scheduling a batch validation job.
| |
responder:IResponder (default = null) |
AsyncToken |
See also
| cancelJobExecutionComplete | Event |
com.esri.drs.DataReviewerTaskEventcom.esri.drs.DataReviewerTaskEvent.CANCEL_JOB_EXECUTION_COMPLETEDispatched when cancelJobExecution operation successfully completes. The event result is a boolean that indicates if the cancel request succeeded.
| deleteJobComplete | Event |
com.esri.drs.DataReviewerTaskEventcom.esri.drs.DataReviewerTaskEvent.DELETE_JOB_COMPLETEDispatched when deleteJob operation completes. The event result is a boolean that indicates if the delete request succeeded.
| disableJobComplete | Event |
com.esri.drs.DataReviewerTaskEventcom.esri.drs.DataReviewerTaskEvent.DISABLE_JOB_COMPLETEDispatched when disableJob operation successfully completes. The event result is a boolean that indicates if the disable request succeeded.
| editJobComplete | Event |
com.esri.drs.DataReviewerTaskEventcom.esri.drs.DataReviewerTaskEvent.EDIT_JOB_COMPLETEDispatched when editJob operation completes. The event result is a boolean that indicates if the edit request succeeded.
| enableJobComplete | Event |
com.esri.drs.DataReviewerTaskEventcom.esri.drs.DataReviewerTaskEvent.ENABLE_JOB_COMPLETEDispatched when enableJob operation completes. The event result is a boolean that indicates if the enable request succeeded.
| executeJobComplete | Event |
com.esri.drs.DataReviewerTaskEventcom.esri.drs.DataReviewerTaskEvent.EXECUTE_JOB_COMPLETEDispatched when executeJob operation successfully completes. The event result string is the adhoc batch validation job ID.
| fault | Event |
mx.rpc.events.FaultEventDispatched when there is a problem accessing the Reviewer Map Server.
| getAdhocJobsListComplete | Event |
com.esri.drs.DataReviewerTaskEventcom.esri.drs.DataReviewerTaskEvent.GET_ADHOC_JOBS_LIST_COMPLETEDispatched when getAdhocJobsList operation successfully completes. The event result is an array of BatchValidationJobDetails instances with adhoc jobs details.
| getJobDetailsComplete | Event |
com.esri.drs.DataReviewerTaskEventcom.esri.drs.DataReviewerTaskEvent.GET_JOB_DETAILS_COMPLETEDispatched when getJobDetails operation successfully completes. The event result is an instance of BatchValidationJobDetails.
| getJobExecutionDetailsComplete | Event |
com.esri.drs.DataReviewerTaskEventcom.esri.drs.DataReviewerTaskEvent.GET_JOB_EXECUTION_DETAILS_COMPLETEDispatched when getJobExecutionDetails operation successfully completes. The event result is an instance of BatchValidationJobExecutionDetails.
| getJobIdsComplete | Event |
com.esri.drs.DataReviewerTaskEventcom.esri.drs.DataReviewerTaskEvent.GET_JOB_IDS_COMPLETEDispatched when getJobIds operation successfully completes. The event result object contains two arrays:
| getScheduledJobsListComplete | Event |
com.esri.drs.DataReviewerTaskEventcom.esri.drs.DataReviewerTaskEvent.GET_SCHEDULED_JOBS_LIST_COMPLETEDispatched when getScheduledJobsList operation successfully completes. The event result is an array of BatchValidationJobDetails instances with scheduled jobs details.
| scheduleJobComplete | Event |
com.esri.drs.DataReviewerTaskEventcom.esri.drs.DataReviewerTaskEvent.SCHEDULE_JOB_COMPLETEDispatched when scheduleJob operation successfully completes. The event result string is the scheduled batch validation job ID.