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

IReviewCommentingAndApprovalUtil  - AS3 Review, Commenting, and Approval

Packagecom.adobe.livecycle.rca.service.core
Interfacepublic interface IReviewCommentingAndApprovalUtil
Implementors ReviewCommentingAndApprovalUtil
Deprecated since Review, Commenting, and Approval 10: Please Use com.adobe.solutions.rca.service.IReviewCommentingAndApprovalUtil

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

Defines core functionality for the Review Commenting and Approval Utility service.



Public Methods
 MethodDefined By
  
Retrieves all deployed pre and post-review processes on the LiveCycle server.
IReviewCommentingAndApprovalUtil
  
Checks whether the invoker has the permission that is required to initiate a review.
IReviewCommentingAndApprovalUtil
  
Checks whether the invoker has the permissions that are specified in a list.
IReviewCommentingAndApprovalUtil
  
Checks whether the invoker has the permissions that are required to read, write, or update a review template.
IReviewCommentingAndApprovalUtil
Method Detail

findCustomRCAProcesses

()method
public function findCustomRCAProcesses():com.adobe.livecycle.rca.token:IAsyncToken

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

Retrieves all deployed pre and post-review processes on the LiveCycle server. The response of the call can be extracted from ResultEvent using a result handler or responder. For example, use event.result.customRCAProcesses to access a map of custom processes returned by findCustomRCAProcesses(). The response is a map containing a list of names of pre and post-review processes that can be used as process hooks or tracking sheet generators.

For more information about pre and post-review processes, see Integrating custom processes before and after a review stage completes in Review, Commenting, and Approval Building Block Technical Guide.

Returns
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you to register for the event. You can extract a map of the names of processes from ResultEvent. For example, use event.result.customRCAProcesses.

hasInitiateReviewPermission

()method 
public function hasInitiateReviewPermission():com.adobe.livecycle.rca.token:IAsyncToken

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

Checks whether the invoker has the permission that is required to initiate a review. That is, RCAPermission.RCA_INITIATE_REVIEW. The response is a Boolean value that can be extracted from ResultEvent using a result handler or responder. The format for ResultEvent is event.result.result.

Returns
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you to register for the event. You can extract a Boolean that specifies whether the user has permission to initiate a review from ResultEvent. For example, use event.result.result.

Related API Elements

hasPermission

()method 
public function hasPermission(permissionList:ArrayCollection):com.adobe.livecycle.rca.token:IAsyncToken

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

Checks whether the invoker has the permissions that are specified in a list. The response is a Boolean value that can be extracted from ResultEvent using a result handler or responder. The format for ResultEvent is event.result.result.

Parameters

permissionList:ArrayCollection — List of permission names.

Returns
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you to register for the event. You can extract a Boolean that specifies whether the user has the specified permission from ResultEvent. For example, use event.result.result.

hasTemplateAuthoringPermission

()method 
public function hasTemplateAuthoringPermission():com.adobe.livecycle.rca.token:IAsyncToken

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

Checks whether the invoker has the permissions that are required to read, write, or update a review template. That is, RCAPermission.RCA_TEMPLATE_READ and RCAPermission.RCA_TEMPLATE_WRITE. The response is a Boolean value can be extracted from ResultEvent using a result handler or responder. The format for ResultEvent is event.result.result.

Returns
com.adobe.livecycle.rca.token:IAsyncToken — A token that allows you to register for the event. You can extract a Boolean that specifies whether the user has permission to author a template from ResultEvent. For example, use event.result.result.

Related API Elements