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

IStartpointManager  - AS3 ADEP Workspace
Packagelc.procmgmt
Interfacepublic 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

The 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

lc.procmgmt.domain.Startpoint
lc.procmgmt.domain.Category

Public Properties
 PropertyDefined By
 InheritedfaultHandler : Function
The default fault handler function.
IManager
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
  
getCategories():lc.foundation.util:CollectionToken
Retrieves all categories of startpoints that are available to an authenticated user.
IStartpointManager
  
getImageUrlForStartpoint(startpoint:Startpoint):String
Retrieves the location of the image for an startpoint.
IStartpointManager
  
getStartpoint(startpointId:String):lc.foundation.util:ObjectToken
Retrieves the startpoint by using the specified startpoint identifer.
IStartpointManager
  
getStartpoints(startpointIds:Array):lc.foundation.util:CollectionToken
Retrieves the startpoints for an array of startpoint identifiers.
IStartpointManager
  
getStartpointsForCategory(categoryName:String):lc.foundation.util:CollectionToken
Retrieves the startpoints in the specified category.
IStartpointManager
 Inherited
handleEvent(token:lc.foundation.util:Token, event:LiveCycleEvent):void
Determines whether the default operation is prevented.
IManager
 Inherited
handleFault(token:lc.foundation.util:Token, event:LiveCycleFaultEvent):void
Determines whether the default operation is prevented.
IManager
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
IEventDispatcher
  
invokeStartpoint(startpointId:String):lc.foundation.util:ObjectToken
Invokes the specified startpoint by its unique identifier.
IStartpointManager
  
invokeStartpointFromStartTask(taskId:String):lc.foundation.util:ObjectToken
Invokes an startpoint with the data from the task that the task ID identified as the initial data.
IStartpointManager
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
IEventDispatcher
 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
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.

Returns
lc.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.

Returns
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.

Returns
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.

Returns
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.

Returns
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.

Returns
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.

Returns
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.



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

 

Legal Notices | Online Privacy Policy