ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
lc.foundation.events 

CollectionResultEvent  - AS3 ADEP Workspace

Packagelc.foundation.events
Classpublic class CollectionResultEvent
InheritanceCollectionResultEvent Inheritance LiveCycleEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The CollectionResultEvent event is dispatched when a collection has been retrieved.



Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  result : ListCollectionView
The result collection object.
CollectionResultEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtoken : lc.foundation.util:Token
[read-only] The token that represents the call to the method.
LiveCycleEvent
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
Constructor.
CollectionResultEvent
  
[override] Creates a copy of a CollectionResultEvent object and sets the value of each property to match that of the original.
CollectionResultEvent
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  ASSIGNMENTS_FOR_TASK_RESULT : String = "assignmentsForTaskResult"
[static] A special value that specifies to retrieve the assignments for a task.
CollectionResultEvent
  COLLECTION_RESULT : String = "collectionResult"
[static] A special value that specifies a generic collection was provided.
CollectionResultEvent
  FILL_ATTACHMENTS : String = "fillAttachments"
[static] A special value that specifies to fill attachments for the task.
CollectionResultEvent
  FILL_CATEGORIES : String = "fillCategories"
[static] A speical value that specifies to fill the process categories.
CollectionResultEvent
  FILL_FAVORITES : String = "fillFavorites"
[static] A special value that specifies to fill the Favorites.
CollectionResultEvent
  FILL_QUEUES : String = "fillQueues"
[static] A special value that specifies to fill the queues.
CollectionResultEvent
  FILL_QUEUE_TASKS : String = "fillQueueTasks"
[static] A special value that specifies to fill the queue tasks.
CollectionResultEvent
  FILL_SEARCH_TEMPLATE_DESCRIPTORS : String = "fillSearchTemplateDescriptors"
[static] A special value that specifies to fill the search template descriptors.
CollectionResultEvent
  FILL_STARTPOINTS : String = "fillStartpoints"
[static] A special value that specifies to fill the Task Manager startpoints (forms) to start a process.
CollectionResultEvent
  FILL_TASK_EXTRAS : String = "fillTaskExtras"
[static] A special value that specifies to fill extras for a task.
CollectionResultEvent
  FILL_TASK_PROCESS_VARIABLES : String = "fillTaskProcessVariables"
[static] A special value that specifies to fill the task process variables.
CollectionResultEvent
  FILL_TASKS : String = "fillTasks"
[static] A special value that specifies to fill the tasks.
CollectionResultEvent
  FILL_USERS : String = "fillUsers"
[static] A special value that specifies to fill the users.
CollectionResultEvent
  GET_ACCESSIBLE_USERS : String = "getAccessibleUsers"
[static] A special value that specifies to retrieve accessible users.
CollectionResultEvent
  GET_GRANTED_USERS : String = "getGrantedUsers"
[static] A special value that specifies to retrieve granted users.
CollectionResultEvent
  GET_GROUPS : String = "getGroups"
[static] A special value that specifies to retrieve the groups.
CollectionResultEvent
  GET_PROCESS_VARIABLE_DEFINITIONS : String = "getProcessVariableDefinitions"
[static] A special value that specifies to retrieve process variable definitions.
CollectionResultEvent
  GET_PROCESS_VARIABLES_FOR_PROCESS_INSTANCE : String = "getProcessVariablesForProcessInstance"
[static] A special value that specifies to retrieve process variables belonging to a process instance.
CollectionResultEvent
  GET_PROCESS_VARIABLES_FOR_QUEUE_FILTER : String = "getProcessVariablesForQueueFilter"
[static] A special value that specifies to retrieve process variables for queue filters.
CollectionResultEvent
  GET_STARTPOINTS : String = "getStartpoints"
[static] A special value that specifies to retrieve Task Manager startpoints to start a process.
CollectionResultEvent
  GET_USERS_IN_GROUP : String = "getUserInGroup"
[static] A special value that specifies to retrieve users belonging to a specifies group.
CollectionResultEvent
  PROCESSES_RESULT : String = "processesResult"
[static] A special value that specifies to retrieve the process the result.
CollectionResultEvent
  PROCESS_INSTANCE_CHILDREN_RESULT : String = "ProcessInstanceChildrenResult"
[static] A special value that specifies to retrieve a list of child processes for a process.
CollectionResultEvent
  PROCESS_INSTANCES_RESULT : String = "processInstancesResult"
[static] A special value that specifies to retrieve the process instances result.
CollectionResultEvent
  SEARCH_COMPLETE : String = "searchComplete"
[static] A special value that specifies the search completed.
CollectionResultEvent
  TASK_FOR_PROCESS_INSTANCE_RESULT : String = "taskForProcessInstanceResult"
[static] A special value that specifies to retrieve the process instance results for a task.
CollectionResultEvent
Property Detail

result

property
public var result:ListCollectionView

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

The result collection object.

Constructor Detail

CollectionResultEvent

()Constructor
public function CollectionResultEvent(type:String, bubbles:Boolean, cancelable:Boolean, collection:ListCollectionView, token:lc.foundation.util:Token)

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Constructor.

Parameters
type:String — Specifies type of the event.
 
bubbles:Boolean — Specifies whether the event object participates in the bubbling stage of the event flow.
 
cancelable:Boolean — Specifies whether the event object can be canceled.
 
collection:ListCollectionView — Specifies the result collection.
 
token:lc.foundation.util:Token — Specifies the request token.
Method Detail

clone

()method
override public function clone():Event

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

Creates a copy of a CollectionResultEvent object and sets the value of each property to match that of the original.

Returns
Event — A copy of the CollectionResultEvent object.
Constant Detail

ASSIGNMENTS_FOR_TASK_RESULT

Constant
public static const ASSIGNMENTS_FOR_TASK_RESULT:String = "assignmentsForTaskResult"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies to retrieve the assignments for a task.

COLLECTION_RESULT

Constant 
public static const COLLECTION_RESULT:String = "collectionResult"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies a generic collection was provided.

FILL_ATTACHMENTS

Constant 
public static const FILL_ATTACHMENTS:String = "fillAttachments"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies to fill attachments for the task.

FILL_CATEGORIES

Constant 
public static const FILL_CATEGORIES:String = "fillCategories"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A speical value that specifies to fill the process categories.

FILL_FAVORITES

Constant 
public static const FILL_FAVORITES:String = "fillFavorites"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies to fill the Favorites.

FILL_QUEUE_TASKS

Constant 
public static const FILL_QUEUE_TASKS:String = "fillQueueTasks"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies to fill the queue tasks.

FILL_QUEUES

Constant 
public static const FILL_QUEUES:String = "fillQueues"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies to fill the queues.

FILL_SEARCH_TEMPLATE_DESCRIPTORS

Constant 
public static const FILL_SEARCH_TEMPLATE_DESCRIPTORS:String = "fillSearchTemplateDescriptors"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies to fill the search template descriptors.

FILL_STARTPOINTS

Constant 
public static const FILL_STARTPOINTS:String = "fillStartpoints"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies to fill the Task Manager startpoints (forms) to start a process.

FILL_TASK_EXTRAS

Constant 
public static const FILL_TASK_EXTRAS:String = "fillTaskExtras"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies to fill extras for a task.

FILL_TASK_PROCESS_VARIABLES

Constant 
public static const FILL_TASK_PROCESS_VARIABLES:String = "fillTaskProcessVariables"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies to fill the task process variables.

FILL_TASKS

Constant 
public static const FILL_TASKS:String = "fillTasks"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies to fill the tasks.

FILL_USERS

Constant 
public static const FILL_USERS:String = "fillUsers"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies to fill the users.

GET_ACCESSIBLE_USERS

Constant 
public static const GET_ACCESSIBLE_USERS:String = "getAccessibleUsers"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies to retrieve accessible users.

GET_GRANTED_USERS

Constant 
public static const GET_GRANTED_USERS:String = "getGrantedUsers"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies to retrieve granted users.

GET_GROUPS

Constant 
public static const GET_GROUPS:String = "getGroups"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies to retrieve the groups.

GET_PROCESS_VARIABLE_DEFINITIONS

Constant 
public static const GET_PROCESS_VARIABLE_DEFINITIONS:String = "getProcessVariableDefinitions"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies to retrieve process variable definitions.

GET_PROCESS_VARIABLES_FOR_PROCESS_INSTANCE

Constant 
public static const GET_PROCESS_VARIABLES_FOR_PROCESS_INSTANCE:String = "getProcessVariablesForProcessInstance"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies to retrieve process variables belonging to a process instance.

GET_PROCESS_VARIABLES_FOR_QUEUE_FILTER

Constant 
public static const GET_PROCESS_VARIABLES_FOR_QUEUE_FILTER:String = "getProcessVariablesForQueueFilter"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies to retrieve process variables for queue filters.

GET_STARTPOINTS

Constant 
public static const GET_STARTPOINTS:String = "getStartpoints"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies to retrieve Task Manager startpoints to start a process.

GET_USERS_IN_GROUP

Constant 
public static const GET_USERS_IN_GROUP:String = "getUserInGroup"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies to retrieve users belonging to a specifies group.

PROCESS_INSTANCE_CHILDREN_RESULT

Constant 
public static const PROCESS_INSTANCE_CHILDREN_RESULT:String = "ProcessInstanceChildrenResult"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies to retrieve a list of child processes for a process.

PROCESS_INSTANCES_RESULT

Constant 
public static const PROCESS_INSTANCES_RESULT:String = "processInstancesResult"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies to retrieve the process instances result.

PROCESSES_RESULT

Constant 
public static const PROCESSES_RESULT:String = "processesResult"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies to retrieve the process the result.

SEARCH_COMPLETE

Constant 
public static const SEARCH_COMPLETE:String = "searchComplete"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies the search completed.

TASK_FOR_PROCESS_INSTANCE_RESULT

Constant 
public static const TASK_FOR_PROCESS_INSTANCE_RESULT:String = "taskForProcessInstanceResult"

Language Version: ActionScript 3.0
Product Version: Adobe Digital Enterprise Platform Document Services - Workspace 9
Runtime Versions: AIR (unsupported), Flash Player 9, Flash Player 10

A special value that specifies to retrieve the process instance results for a task.