Packagecom.esri.ags.events
Classpublic class GeoprocessorEvent
InheritanceGeoprocessorEvent Inheritance flash.events.Event

Represents event objects that are specific to Geoprocessor tasks. This could be either ExecuteResult, ParameterValue or JobInfo.

See also

com.esri.ags.tasks.Geoprocessor
Live Sample - using GeoprocessorEvent (with executeComplete).
Live Sample - using GeoprocessorEvent (with event listener).
Live Sample - using GeoprocessorEvent (with executeComplete).


Public Properties
 PropertyDefined By
  executeResult : ExecuteResult
Execute result.
GeoprocessorEvent
  jobInfo : JobInfo
This property is set when the type is jobComplete or statusUpdate.
GeoprocessorEvent
  parameterValue : ParameterValue
This property is set when the type is getResultDataComplete, getInputComplete or getResultImageComplete
GeoprocessorEvent
Public Methods
 MethodDefined By
  
GeoprocessorEvent(type:String, executeResult:ExecuteResult = null, parameterValue:ParameterValue = null, jobInfo:JobInfo = null)
Creates a new GeoprocessorEvent.
GeoprocessorEvent
Public Constants
 ConstantDefined By
  EXECUTE_COMPLETE : String = executeComplete
[static] Defines the value of the type property of an executeComplete event object.
GeoprocessorEvent
  GET_INPUT_COMPLETE : String = getInputComplete
[static] Defines the value of the type property of a getInputComplete event object.
GeoprocessorEvent
  GET_RESULT_DATA_COMPLETE : String = getResultDataComplete
[static] Defines the value of the type property of a getResultDataComplete event object.
GeoprocessorEvent
  GET_RESULT_IMAGE_COMPLETE : String = getResultImageComplete
[static] Defines the value of the type property of a getResultImageComplete event object.
GeoprocessorEvent
  JOB_COMPLETE : String = jobComplete
[static] Defines the value of the type property of a jobComplete event object.
GeoprocessorEvent
  STATUS_UPDATE : String = statusUpdate
[static] Defines the value of the type property of a statusUpdate event object.
GeoprocessorEvent
Property Detail
executeResultproperty
public var executeResult:ExecuteResult

Execute result. This property is set when the type is executeComplete.

jobInfoproperty 
public var jobInfo:JobInfo

This property is set when the type is jobComplete or statusUpdate.

parameterValueproperty 
public var parameterValue:ParameterValue

This property is set when the type is getResultDataComplete, getInputComplete or getResultImageComplete

Constructor Detail
GeoprocessorEvent()Constructor
public function GeoprocessorEvent(type:String, executeResult:ExecuteResult = null, parameterValue:ParameterValue = null, jobInfo:JobInfo = null)

Creates a new GeoprocessorEvent.

Parameters
type:String — The event type; indicates the action that triggered the event.
 
executeResult:ExecuteResult (default = null) — The result of a Geoprocessor execute task.
 
parameterValue:ParameterValue (default = null) — The output parameters from a Geoprocessor task.
 
jobInfo:JobInfo (default = null) — The job info.
Constant Detail
EXECUTE_COMPLETEConstant
public static const EXECUTE_COMPLETE:String = executeComplete

Defines the value of the type property of an executeComplete event object.

GET_INPUT_COMPLETEConstant 
public static const GET_INPUT_COMPLETE:String = getInputComplete

Defines the value of the type property of a getInputComplete event object.

GET_RESULT_DATA_COMPLETEConstant 
public static const GET_RESULT_DATA_COMPLETE:String = getResultDataComplete

Defines the value of the type property of a getResultDataComplete event object.

GET_RESULT_IMAGE_COMPLETEConstant 
public static const GET_RESULT_IMAGE_COMPLETE:String = getResultImageComplete

Defines the value of the type property of a getResultImageComplete event object.

JOB_COMPLETEConstant 
public static const JOB_COMPLETE:String = jobComplete

Defines the value of the type property of a jobComplete event object.

STATUS_UPDATEConstant 
public static const STATUS_UPDATE:String = statusUpdate

Defines the value of the type property of a statusUpdate event object.