com.adobe.solutions.rca.service

# IStageManagement - AS3 Review, Commenting, and Approval

Package | com.adobe.solutions.rca.service
Interface | public interface IStageManagement
Implementors | StageManager

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

Signatures of operations supported on stage templates.

Public Methods

| Method | Defined By
--- | --- | ---
|  | createStageTemplate(stageTemplate:com.adobe.solutions.rca.vo:StageTemplateVO, overwrite:Boolean):mx.rpc:AsyncToken This operation creates a new stage template in the system. | IStageManagement
|  | deleteStageTemplate(templateName:String):mx.rpc:AsyncToken This operation deletes a stage template from the system. | IStageManagement
|  | getReviewTemplatesReferring(templateName:String):mx.rpc:AsyncToken This operation gets all ReviewTemplateVOs referring to a StageTemplateVO. | IStageManagement
|  | getStageTemplate(templateName:String):mx.rpc:AsyncToken This operation gets a StageTemplateVO given its ID. | IStageManagement
|  | searchStage(stageTemplateSearchFilter:com.adobe.solutions.rca.vo:StageTemplateSearchFilterVO):mx.rpc:AsyncToken This operation searches for StageTemplateVO based on StageTemplateSearchFilter. | IStageManagement

Method Detail

### createStageTemplate

()
method

`public function createStageTemplate(stageTemplate:com.adobe.solutions.rca.vo:StageTemplateVO, overwrite:Boolean):mx.rpc:AsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

This operation creates a new stage template in the system.

Parameters

| `stageTemplate:com.adobe.solutions.rca.vo:StageTemplateVO` — `StageTemplateVO` to be created.
| `overwrite:Boolean` — A Boolean value for error-proof overwriting of stage templates. If the value is `True` and a template exists with same name, then the existing template is replaced with the provided `stageTemplate`.

Returns

| `mx.rpc:AsyncToken` — It returns a token on which success or failure handlers can be attached. The resulting event contains the created `stageTemplateVO`.

### deleteStageTemplate

()
method

`public function deleteStageTemplate(templateName:String):mx.rpc:AsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

This operation deletes a stage template from the system. If this stage is referred by one (or more) `ReviewTemplateVO`, delete operation fails with an appropriate exception.

Parameters

| `templateName:String` — The unique stage template name.

Returns

| `mx.rpc:AsyncToken` — It returns a token on which success or failure handlers can be attached. The resulting event contains the deleted `StageTemplateVO`.

### getReviewTemplatesReferring

()
method

`public function getReviewTemplatesReferring(templateName:String):mx.rpc:AsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

This operation gets all `ReviewTemplateVOs` referring to a `StageTemplateVO`.

Parameters

| `templateName:String` — The unique stage template name.

Returns

| `mx.rpc:AsyncToken` — It returns a token on which success or failure handlers can be attached. The resulting event contains a list of `ReviewTemplatVO` referring to the stage template with name `templateName`.

### getStageTemplate

()
method

`public function getStageTemplate(templateName:String):mx.rpc:AsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

This operation gets a `StageTemplateVO` given its ID.

Parameters

| `templateName:String` — The unique stage template name.

Returns

| `mx.rpc:AsyncToken` — It returns a token on which success or failure handlers can be attached. The resulting event contains the `StageTemplateVO` or `null` if the stage does not exist.

### searchStage

()
method

`public function searchStage(stageTemplateSearchFilter:com.adobe.solutions.rca.vo:StageTemplateSearchFilterVO):mx.rpc:AsyncToken`

Language Version: | ActionScript 3.0

Product Version: | Review, Commenting, and Approval Building Block 10

Runtime Versions: | Flash Player 10.2, AIR (unsupported)

This operation searches for `StageTemplateVO` based on `StageTemplateSearchFilter`.

Parameters

| `stageTemplateSearchFilter:com.adobe.solutions.rca.vo:StageTemplateSearchFilterVO` — Defines the search criteria.

Returns

| `mx.rpc:AsyncToken` — It returns a token on which success or failure handlers can be attached. The resulting event contains a list of `StageTemplateVO` found in the system matching the criteria

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