ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.solutions.exm.authoring.domain.expression 

IExpressionProvider  - AS3 Expression Manager
Packagecom.adobe.solutions.exm.authoring.domain.expression
Interfacepublic interface IExpressionProvider extends IEventDispatcher

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

The IExpressionProvider interface serves as the entry point for expression-specific operations during expression authoring.


Public Methods
 MethodDefined By
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
IEventDispatcher
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
IEventDispatcher
  
getExpression(exprId:String):void
Fires an asynchronous operation for retrieving the expression with the given ID from the expression repository.
IExpressionProvider
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
IEventDispatcher
  
listExpressions():String
Fires an asynchronous operation for retrieving the list of all available expressions.
IExpressionProvider
  
newExpression():IExpression
Creates a new transient expression object and returns it.
IExpressionProvider
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
IEventDispatcher
  
searchExpressions(searchTerm:String):String
Fires an asynchronous operation for retrieving the list of available expressions matching the given search term.
IExpressionProvider
  
validate(expressions:IList):void
Validates a batch of expressions (IExpression instances) for syntactic correctness and cyclic dependencies.
IExpressionProvider
 Inherited
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
IEventDispatcher
Events
Click for more information on events
 Event Summary Defined By
  
expressionGetError
Dispatched when the provider encounters an error retrieving an expression from the repository.IExpressionProvider
  
expressionGetEvent
Dispatched when the provider successfully retrieves an expression from the repository.IExpressionProvider
  
expressionListError
Dispatched when the provider encounters an error retrieving a set of expressions from the repository.IExpressionProvider
  
expressionListProviderEvent
Dispatched when the provider successfully retrieves a set of expressions from the repository.IExpressionProvider
Method Detail

getExpression

()method
public function getExpression(exprId:String):void

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Fires an asynchronous operation for retrieving the expression with the given ID from the expression repository. Returns immediately and causes the current object to later dispatch one of the following events:

  • If the operation completes successfully, an event with name "expressionGetEvent" of type ExpressionGetEvent. The 'expression' property of the event will be a reference to the loaded expression object, and will have the same ID as the one passed as input to this method.
  • If the operation errors out, an event with name "expressionGetError" of type ErrorEvent. The 'error' property of the event will contain the actual error thrown by the operation.

Parameters

exprId:String — The ID of the expression to be retrieved.

listExpressions

()method 
public function listExpressions():String

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Fires an asynchronous operation for retrieving the list of all available expressions. Returns immediately and causes the current object to later dispatch one of the following events:

  • If the operation completes successfuly, an event with name "expressionListProviderEvent" of type ExpressionListProviderEvent. The 'expressions' property of the event will be a reference to the list of expressions (IExpression objects) in the system. The 'requestId' property of the event will be the same as the value returned by this method, which is a unique string that calling code can use for correlating calls to this method with events dispatched later.
  • If the operation errors out, an event with name "expressionListError" of type RequestAwareErrorEvent. The 'requestId' property of the event will be the same as the value returned by this method, while the 'error' property will contain the actual error thrown by the operation.

Returns
String — A unique request ID which calling code can use for correlating invocations of this method with events dispatched later.

newExpression

()method 
public function newExpression():IExpression

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Creates a new transient expression object and returns it.

Returns
IExpression — A new transient expression object.

searchExpressions

()method 
public function searchExpressions(searchTerm:String):String

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Fires an asynchronous operation for retrieving the list of available expressions matching the given search term. Returns immediately and causes the current object to later dispatch one of the following events:

  • If the operation completes successfuly, an event with name "expressionListProviderEvent" of type ExpressionListProviderEvent. The 'expressions' property of the event will be a reference to the list of matching expressions (IExpression objects). The 'requestId' property of the event will be the same as the value returned by this method, which is a unique string that calling code can use for correlating calls to this method with events dispatched later.
  • If the operation errors out, an event with name "expressionListError" of type RequestAwareErrorEvent. The 'requestId' property of the event will be the same as the value returned by this method, while the 'error' property will contain the actual error thrown by the operation.

Parameters

searchTerm:String

Returns
String — A unique request ID which calling code can use for correlating invocations of this method with events dispatched later.

validate

()method 
public function validate(expressions:IList):void

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Validates a batch of expressions (IExpression instances) for syntactic correctness and cyclic dependencies. Returns quietly if validation succeeds, else throws one of the following errors:

  • ExpressionValidationError if any of the expressions is syntactically incorrect.
  • SimpleCyclicDependencyError if a simple cycle involving one variable is detected in an expression.
  • ComplexCyclicDependencyError if a complex cycle involving two or more variables is detected over multiple expressions.

Parameters

expressions:IList — The list of expressions (IExpression instances) to be validated.
Event Detail

expressionGetError

 Event
Event Object Type: com.adobe.solutions.exm.authoring.domain.ErrorEvent

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Dispatched when the provider encounters an error retrieving an expression from the repository.

expressionGetEvent

 Event  
Event Object Type: com.adobe.solutions.exm.authoring.domain.expression.ExpressionGetEvent

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Dispatched when the provider successfully retrieves an expression from the repository.

expressionListError

 Event  
Event Object Type: com.adobe.solutions.exm.authoring.domain.RequestAwareErrorEvent

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Dispatched when the provider encounters an error retrieving a set of expressions from the repository.

expressionListProviderEvent

 Event  
Event Object Type: com.adobe.solutions.exm.authoring.domain.expression.ExpressionListProviderEvent

Language Version: ActionScript 3.0
Product Version: Expression Manager Building Block 10
Runtime Versions: AIR (unsupported), Flash Player 10.2

Dispatched when the provider successfully retrieves a set of expressions from the repository.




© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy