| Package | lc.procmgmt |
| Interface | public interface IStartpointManager extends IManager , IEventDispatcher |
| 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 |
IStartpointManager interface is implemented to manage TaskManager startpoints.
Workspace start points that are added to a process diagram create TaskManager startpoints. TaskManager
startpoints are invoked to start the process by using Workspace. When using Workspace to
start a process, a form is always used. A PDF form or form data is passed as input to the process. For more information about creating processes for Workspace,
see "Designing human-centric processes" in
Adobe Digital Enterprise Platform Document Services - Workbench 10.0 Help
.
Implement the IStartpointManager interface to get categories of startpoints,
invoke startpoints, retrieve startpoints, and get images associated with startpoints.
Related API Elements
Public Properties
Hide Inherited Public Properties
Show Inherited Public PropertiesPublic Methods
| Method | Defined By | ||
|---|---|---|---|
 | 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 | |
|
Dispatches an event into the event flow. | IEventDispatcher | |
Retrieves all categories of startpoints that are available to an authenticated user. | IStartpointManager | ||
Retrieves the location of the image for an startpoint. | IStartpointManager | ||
Retrieves the startpoint by using the specified startpoint identifer. | IStartpointManager | ||
Retrieves the startpoints for an array of startpoint identifiers. | IStartpointManager | ||
Retrieves the startpoints in the specified category. | IStartpointManager | ||
|
Determines whether the default operation is prevented. | IManager | |
|
Determines whether the default operation is prevented. | IManager | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | IEventDispatcher | |
Invokes the specified startpoint by its unique identifier. | IStartpointManager | ||
Invokes an startpoint with the data from the task that the task ID identified as the initial data. | IStartpointManager | ||
|
Removes a listener from the EventDispatcher object. | IEventDispatcher | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher | |
Method Detail
getCategories | () | method |
public function getCategories():lc.foundation.util:CollectionToken| 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 |
Retrieves all categories of startpoints that are available to an authenticated user.
Returnslc.foundation.util:CollectionToken — A collection of tokens that contains Category objects
when the request is complete. You can set the result and fault handlers on each Token object
to be called when the invocation is complete and the collection is fully populated.
|
getImageUrlForStartpoint | () | method |
public function getImageUrlForStartpoint(startpoint:Startpoint):String| 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 |
Retrieves the location of the image for an startpoint.
Parameters
startpoint:Startpoint — Specifies the startpoint to locate an image for.
|
String — A URL that represents the location of the image.
|
getStartpoint | () | method |
public function getStartpoint(startpointId:String):lc.foundation.util:ObjectToken| 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 |
Retrieves the startpoint by using the specified startpoint identifer.
Parameters
startpointId:String — Specifies the unique identifier of an startpoint.
|
lc.foundation.util:ObjectToken — A token that will contain the Startpoint object when the request is complete.
You can set result and fault handlers on the token to be called when the invocation
is complete and the result is returned.
|
getStartpoints | () | method |
public function getStartpoints(startpointIds:Array):lc.foundation.util:CollectionToken| 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 |
Retrieves the startpoints for an array of startpoint identifiers.
Parameters
startpointIds:Array — Specifies startpoint identifiers as an array.
|
lc.foundation.util:CollectionToken — A token that contains a collection of Startpoint objects when the request is complete.
You can set result and fault handlers on the token to be called when the invocation is
complete and the collection is fully populated.
|
getStartpointsForCategory | () | method |
public function getStartpointsForCategory(categoryName:String):lc.foundation.util:CollectionToken| 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 |
Retrieves the startpoints in the specified category.
Parameters
categoryName:String — Specifies the unique identifier of the category.
|
lc.foundation.util:CollectionToken — A token that contains a collection of Startpoint objects when the request is complete.
You can set result and fault handlers on the token to be called when the invocation is
complete and the collection is fully populated.
|
invokeStartpoint | () | method |
public function invokeStartpoint(startpointId:String):lc.foundation.util:ObjectToken| 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 |
Invokes the specified startpoint by its unique identifier. If the startpoint returns a
Document object on the server-side, a DocumentReference object
is returned; if the startpoint returns task information, a Task object
is returned. Invoked startpoints return either a DocumentReference or Task object.
Parameters
startpointId:String — Specifies the unique identifier of the startpoint to invoke.
|
lc.foundation.util:ObjectToken — A token that will contain the startpoint invocation result, a Task, or a DocumentReference object
when the request is complete. You can set result and fault handlers on the token to be called when the invocation is
complete and the result is returned.
|
invokeStartpointFromStartTask | () | method |
public function invokeStartpointFromStartTask(taskId:String):lc.foundation.util:ObjectToken| 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 |
Invokes an startpoint with the data from the task that the task ID identified as the initial data.
The invoked startpoint returns a DocumentReference object when a Document object is
returned on the server-side. A Task object is returned when an startpoint returns task
information.
Parameters
taskId:String — Specifies the unique identifier of the Task object to create a new task.
|
lc.foundation.util:ObjectToken — An ObjectToken object that contains the startpoint invocation result.
A Task or a DocumentReference object is provided.
You can set result and fault handlers on the ObjectToken object that
are called when the invocation is complete and the result is returned.
|
Mon Apr 10 2017, 12:28 PM -07:00