lc.procmgmt

# IFavoritesManager - AS3 ADEP Workspace

Package | lc.procmgmt
Interface | public interface IFavoritesManager
Implementors | FavoritesManager

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 `IFavoritesManager` interface is implemented to manage favorite TaskManager startpoints. Workspace start points that are added to a process diagram create TaskManager startpoints. TaskManager startpoints are used to invoke a process in Workspace. When you use Workspace to invoke a 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 `IFavoritesManager` interface to retrieve, add, and remove the favorites.

Related API Elements

lc.procmgmt.domain.FavoriteCategory

Public Properties

| Property | Defined By
--- | --- | ---
|  | favorites : ListCollectionView The ListCollectionView object that contains a list of favorites. | IFavoritesManager

Public Methods

| Method | Defined By
--- | --- | ---
|  | addToFavorites(startpoint:Startpoint):lc.foundation.util:Token Adds an startpoint to the Favorites collection. | IFavoritesManager
|  | isFavorite(startpoint:Startpoint):Boolean Returns whether the specified startpoint is a favorite. | IFavoritesManager
|  | removeFromFavorites(startpoint:Startpoint):lc.foundation.util:Token Removes an startpoint from the Favorites collection. | IFavoritesManager

Property Detail

### favorites

property

`favorites: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 `ListCollectionView` object that contains a list of favorites.

Implementation
`public function get favorites():ListCollectionView`
`public function set favorites(value:ListCollectionView):void`
Method Detail

### addToFavorites

()
method

`public function addToFavorites(startpoint:Startpoint):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

Adds an startpoint to the Favorites collection.

Parameters

| `startpoint:Startpoint` — Specifies the startpoint to add to the favorites.

Returns

| `lc.foundation.util:Token` — A token used to set result and fault handlers to be called when the operation has completed.

### isFavorite

()
method

`public function isFavorite(startpoint:Startpoint):Boolean`

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

Returns whether the specified startpoint is a favorite.

Parameters

| `startpoint:Startpoint` — Specifies the startpoint to add as a favorite.

Returns

| `Boolean` — A flag that indicates whether an startpoint is a favorite. A value of `true` specifies that it is a favorite.

### removeFromFavorites

()
method

`public function removeFromFavorites(startpoint:Startpoint):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

Removes an startpoint from the Favorites collection.

Parameters

| `startpoint:Startpoint` — Specifies the startpoint to remove from the favorites.

Returns

| `lc.foundation.util:Token` — A token used to set result and fault handlers to be called when the operation is completed.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00