Packageimpression.events
Classpublic class RulesEngineRemediationRequestEvent
InheritanceRulesEngineRemediationRequestEvent Inheritance flash.events.Event

An object that implements IRulesEngine dispatches a RulesEngineRemediationRequestEvent object when remediation should be performed.



Public Properties
 PropertyDefined By
  message : String
[read-only] The remediation message to display.
RulesEngineRemediationRequestEvent
  remediationData : *
[read-only] Additional remediation data.
RulesEngineRemediationRequestEvent
Public Methods
 MethodDefined By
  
RulesEngineRemediationRequestEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, message:String, remediationData:* = null)
Creates a new instance of a RemediationRequestEvent object.
RulesEngineRemediationRequestEvent
  
clone():Event
[override] Duplicates an instance of the event object.
RulesEngineRemediationRequestEvent
  
toString():String
[override] Returns a string containing all the properties of the RulesEngineRemediationRequestEvent object.
RulesEngineRemediationRequestEvent
Public Constants
 ConstantDefined By
  REQUEST_REMEDIATION : String = rulesEngineRequestRemediation
[static] The RulesEngineRemediationRequestEvent.REQUEST_REMEDIATION constant defines the value of the type property of a remediation request event object.
RulesEngineRemediationRequestEvent
Property Detail
messageproperty
message:String  [read-only]

The remediation message to display.


Implementation
    public function get message():String
remediationDataproperty 
remediationData:*  [read-only]

Additional remediation data. This data is project-defined.


Implementation
    public function get remediationData():*
Constructor Detail
RulesEngineRemediationRequestEvent()Constructor
public function RulesEngineRemediationRequestEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, message:String, remediationData:* = null)

Creates a new instance of a RemediationRequestEvent object.

Parameters
type:String — The type of the event. Event listeners can access this information through the inherited type property.
 
bubbles:Boolean (default = false) — Determines whether the event object participates in the bubbling phase of the event flow. Event listeners can access this information through the inheritied bubbles property.
 
cancelable:Boolean (default = false) — Determines whether the event object can be canceled. Event listeners can access this information through the inherited cancelable property.
 
message:String — The remediation message to display. Event listeners can access this information through the message property.
 
remediationData:* (default = null) — Additional remediation data. Event listeners can access this information through the remediationData property.
Method Detail
clone()method
override public function clone():Event

Duplicates an instance of the event object.

Returns a new RulesEngineRemediationRequestEvent object that is a copy of the original instance of the RulesEngineRemediationRequestEvent object. You do not normally call clone(); the EventDispatcher class calls it automatically when you redispatch an event--that is, when you call dispatchEvent(event) from a handler that is handling event.

Returns
Event — A new RulesEngineRemediationRequestEvent object that is identical to the original.
toString()method 
override public function toString():String

Returns a string containing all the properties of the RulesEngineRemediationRequestEvent object. The string is in the following format:

[RulesEngineRemediationRequestEvent type=value bubbles=value cancelable=value eventPhase=value message=value remediationData=value]

Returns
String — A string containing all the properties of the RulesEngineRemediationRequestEvent object.
Constant Detail
REQUEST_REMEDIATIONConstant
public static const REQUEST_REMEDIATION:String = rulesEngineRequestRemediation

The RulesEngineRemediationRequestEvent.REQUEST_REMEDIATION constant defines the value of the type property of a remediation request event object. This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object that raised the event.
messageThe remediation message to display.
remediationDataAdditional remediation data.