ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
com.adobe.solutions.rca.services.impl 

StageManager  - AS3 Review, Commenting, and Approval
Packagecom.adobe.solutions.rca.services.impl
Classpublic class StageManager
InheritanceStageManager Inheritance Object
Implements IStageManagement

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10
Runtime Versions: Flash Player 10.2, AIR (unsupported)

This class implements operations supported on stage templates.


Public Properties
 PropertyDefined By
  channelSet : ChannelSet
Channel set for remote operation calls.
StageManager
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
Public Methods
 MethodDefined By
  
StageManager()
The constructor for StageManager class.
StageManager
  
createStageTemplate(stageTemplate:com.adobe.solutions.rca.vo:StageTemplateVO, overwrite:Boolean):mx.rpc:AsyncToken
This operation creates a new stage template in the system.
StageManager
  
deleteStageTemplate(templateName:String):mx.rpc:AsyncToken
This operation deletes a stage template from the system.
StageManager
  
getReviewTemplatesReferring(templateName:String):mx.rpc:AsyncToken
This operation gets all ReviewTemplateVOs referring to a StageTemplateVO.
StageManager
  
getStageTemplate(templateName:String):mx.rpc:AsyncToken
This operation gets a StageTemplateVO given its ID.
StageManager
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
  
searchStage(stageTemplateSearchFilter:com.adobe.solutions.rca.vo:StageTemplateSearchFilterVO):mx.rpc:AsyncToken
This operation searches for StageTemplateVO based on StageTemplateSearchFilter.
StageManager
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Property Detail

channelSet

property
channelSet:ChannelSet

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

Channel set for remote operation calls.



Implementation
    public function get channelSet():ChannelSet
    public function set channelSet(value:ChannelSet):void
Constructor Detail

StageManager

()Constructor
public function StageManager()

Language Version: ActionScript 3.0
Product Version: Review, Commenting, and Approval Building Block 10.0
Runtime Versions: Flash Player 10.2, AIR (unsupported)

The constructor for StageManager class.

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



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

 

Legal Notices | Online Privacy Policy