| Package | lc.procmgmt.ui.endpoint |
| Class | public class StartProcessModel |
| Inheritance | StartProcessModel  NavigationSupervisorModel PresentationModel EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
StartProcessModel class acts as the model for the
StartProcess component.
The StartProcessModel class loads the contents of the list data into the navigation area
in the StartProcess component. The list data contains favorites and
the available categories configured on a LiveCycle ES2 server. Depending on the selection of a
Category or FavoriteCategory object, the appropriate set
of forms to start a process are loaded into the content area of the component.
Each form that starts a process is represented as an Endpoint object.
Related API Elements
lc.procmgmt.domain.Category
lc.procmgmt.domain.Endpoint
lc.procmgmt.ui.endpoint.StartProcessModel
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| endpointFromUrl : Endpoint
The URL for starting a process. | StartProcessModel | ||
| endpointSelectorModel : EndpointSelectorModel
The model for the EndpointSelector. | StartProcessModel | ||
| iconSource : Class
The icon source. | StartProcessModel | ||
| listData : AggregatingCollection
A collection of Category objects and FavoriteCategory objects. | StartProcessModel | ||
| selectedListItem : Object
The currently selected item in the listData property. | StartProcessModel | ||
| session : SessionMap [override]
Retrieves an instance of the current session map. | StartProcessModel | ||
| state : String [read-only]
The name of the state the current view is in. | PresentationModel | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | StartProcessModel | ||
| 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. | EventDispatcher | |
| bindProperty(destination:Object, destinationProperty:String, source:Object, sourceChain:Object, commitOnly:Boolean = false):ChangeWatcher
Binds a public property on the destination object from a property or
property chain on the source object. | PresentationModel | |
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Returns the corresponding cascading style sheet (CSS) property to use based on the specified parameters. | PresentationModel | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
[override]
| StartProcessModel | ||
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
Setting the selected task causes the QueueEntryData object that
contains the selected task to have its details property set to true, and
requests the QueueEntryData object to change to the selected
task. | StartProcessModel | ||
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
| Method | Defined By | ||
|---|---|---|---|
Loads the categories from the SessionMap object and adds them to
the listData property. | StartProcessModel | ||
|
Sets the state property to a new value and causes a PropertyChangeEvent event. | PresentationModel | |
| Constant | Defined By | ||
|---|---|---|---|
| STATE_INITIAL : String = "initialState" [static]
A special value that indicates that initialization is occurring and the categories have not been loaded. | StartProcessModel | ||
| STATE_LOAD_ERROR : String = "loadErrorState" [static]
A special value that indicates that an error occurred while loading the categories. | StartProcessModel | ||
| STATE_LOADING : String = "loadingState" [static]
A special value that indicates that categories are being loading. | StartProcessModel | ||
| STATE_READY : String = "loadReadyState" [static]
A special value that indicates the process of loading categories is complete. | StartProcessModel | ||
endpointFromUrl | property |
endpointFromUrl:Endpoint| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The URL for starting a process.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get endpointFromUrl():Endpoint public function set endpointFromUrl(value:Endpoint):voidendpointSelectorModel | property |
endpointSelectorModel:EndpointSelectorModel| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The model for the EndpointSelector.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get endpointSelectorModel():EndpointSelectorModel public function set endpointSelectorModel(value:EndpointSelectorModel):voidiconSource | property |
iconSource:Class| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The icon source.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get iconSource():Class public function set iconSource(value:Class):voidlistData | property |
listData:AggregatingCollection| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
A collection of Category objects and FavoriteCategory objects.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get listData():AggregatingCollection public function set listData(value:AggregatingCollection):voidselectedListItem | property |
selectedListItem:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The currently selected item in the listData property.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get selectedListItem():Object public function set selectedListItem(value:Object):voidsession | property |
session:SessionMap[override] | Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Retrieves an instance of the current session map.
Implementation
override public function get session():SessionMap override public function set session(value:SessionMap):voidStartProcessModel | () | Constructor |
public function StartProcessModel()| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Constructor.
initialize | () | method |
override public function initialize():void
loadCategories | () | method |
protected function loadCategories():lc.foundation.util:Token| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Loads the categories from the SessionMap object and adds them to
the listData property.
lc.foundation.util:Token — A Token object that identifies whether the operation was successful.
|
selectEndpoint | () | method |
public function selectEndpoint(endpoint:Endpoint):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Setting the selected task causes the QueueEntryData object that
contains the selected task to have its details property set to true, and
requests the QueueEntryData object to change to the selected
task.
Parameters
endpoint:Endpoint — Specifies the task to be selected.
|
STATE_INITIAL | Constant |
public static const STATE_INITIAL:String = "initialState"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
A special value that indicates that initialization is occurring and the categories have not been loaded.
STATE_LOAD_ERROR | Constant |
public static const STATE_LOAD_ERROR:String = "loadErrorState"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
A special value that indicates that an error occurred while loading the categories.
STATE_LOADING | Constant |
public static const STATE_LOADING:String = "loadingState"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
A special value that indicates that categories are being loading.
STATE_READY | Constant |
public static const STATE_READY:String = "loadReadyState"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Experience Services - Document Services ES2 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
A special value that indicates the process of loading categories is complete.
Wed Nov 21 2018, 06:34 AM -08:00