Adobe® Flash® Platform용 ActionScript® 3.0 참조 설명서
 |  패키지 및 클래스 목록 숨기기 |  패키지  |  클래스  |  새로운 내용  |  색인  |  부록  |  영어로 표시되는 이유
필터: 서버에서 데이터를 검색하는 중...
서버에서 데이터를 검색하는 중...
com.adobe.solutions.rca.service 

IReviewCommentingAndApproval  - AS3 Review, Commenting, and Approval

패키지com.adobe.solutions.rca.service
인터페이스public interface IReviewCommentingAndApproval
구현자 ReviewCommentingAndApproval

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

Signature for core service of Review Commenting and Approval Building Block 10.0.



공용 메서드
 메서드정의 주체
  
This operation adds a new non-moderator participant in an ongoing creation, review, or approval stage.
IReviewCommentingAndApproval
  
This API deletes a review template from the system.
IReviewCommentingAndApproval
  
This API returns the native review document, if present or the PDF file of the review document.
IReviewCommentingAndApproval
  
getCommentsForParticipant(reviewId:String, revision:int, stageNo:int, participantOid:String):mx.rpc:AsyncToken
This API retrieves the RSS file of comments, for a particular reviewer.
IReviewCommentingAndApproval
  
getDocument(reviewId:String, revision:int, documentPath:String):mx.rpc:AsyncToken
This API retrieves a file from the review zone associated with the provided review ID and revision.
IReviewCommentingAndApproval
  
This API retrieves a review document with comments, from all reviewers of a review stage.
IReviewCommentingAndApproval
  
This operation retrieves the review context for a given process ID.
IReviewCommentingAndApproval
  
This operation returns ReviewContextVO for the specified review and revision of the review.
IReviewCommentingAndApproval
  
This API fetches a ReviewTemplateVO from the system.
IReviewCommentingAndApproval
  
Searches for review revisions of the review specified by reviewId.
IReviewCommentingAndApproval
  
getStageDocument(reviewId:String, revision:int, stageNo:int):mx.rpc:AsyncToken
This API retrieves a prepared stage document.
IReviewCommentingAndApproval
  
This operation gets the user preferences for a particular user.
IReviewCommentingAndApproval
  
This method initiates a multi-stage process consisting of a creation, a review, or an approval stages on an asset.
IReviewCommentingAndApproval
  
purgeReviews(reviewIdList:IList, clearReviewZone:Boolean):mx.rpc:AsyncToken
This operation removes data for a particular review from the system.
IReviewCommentingAndApproval
  
This operation removes a non-moderator participant from an ongoing stage.
IReviewCommentingAndApproval
  
This API makes a reference stage inline.
IReviewCommentingAndApproval
  
reviseReview(reviewId:String, stageNo:int, reviewDocument:File, changeDescription:String):mx.rpc:AsyncToken
This operation generates a new revision of a review from a particular stage.
IReviewCommentingAndApproval
  
This operation revokes the review specified by review identifier.
IReviewCommentingAndApproval
  
Searches for reviews as specified by the reviewSearchFilter.
IReviewCommentingAndApproval
  
This API searchs for schedule templates in the system.
IReviewCommentingAndApproval
  
setStageDisposition(reviewId:String, revision:int, stageNo:int, disposition:String):mx.rpc:AsyncToken
This API sets the disposition of a stage.
IReviewCommentingAndApproval
  
setUserPreference(domain:String, canonicalName:String, userPreference:UserPreferenceVO):mx.rpc:AsyncToken
This operation sets the user preferences for a particular user.
IReviewCommentingAndApproval
  
storeContentInCRX(absSpacePath:String, fileName:String, document:File, throwOsgiEventOnly:Boolean):mx.rpc:AsyncToken
This internal API stores a file in ADEP Content Repository.
IReviewCommentingAndApproval
  
This operation stores a ReviewTemplateVO in the system.
IReviewCommentingAndApproval
  
This API is used to mark an optional reviewer mandatory and vice-versa.
IReviewCommentingAndApproval
  
updateCustomAttributes(reviewId:String, revision:int, customAttributes:IList, discardOld:Boolean):mx.rpc:AsyncToken
This operation updates the searchable custom attributes of a review.
IReviewCommentingAndApproval
  
updateStageDuration(reviewId:String, stageNo:int, duration:int, durationUnit:String):mx.rpc:AsyncToken
This operation updates the stage duration of an already running RCA Process.
IReviewCommentingAndApproval
메서드 세부 정보

addParticipantToStage

()메서드
public function addParticipantToStage(reviewId:String, stageNo:int, stageParticipant:StageParticipantVO):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

This operation adds a new non-moderator participant in an ongoing creation, review, or approval stage. The following rules apply for review stages:

  • A reviewer can only be added in the current revision of a review and approval process. Any future revision, if any, have this new reviewer.
  • A reviewer can only be added in an ongoing or any future stages of the review and approval process.
  • A reviewer cannot be added to an approval stage.
The following rules apply to approval stages:
  • An approver can only be added in the current revision of a review and approval process. Any future revision, if any, have this new approver.
  • An approver can only be added in an ongoing or any future stage of a review and approval process.
  • An approver cannot be added to a review stage.

매개 변수

reviewId:String — The review identifier to uniquely identify the review.
 
stageNo:int — The stage number inside the review.
 
stageParticipant:StageParticipantVO — The StageParticipantVO having UMOID or domain or canonical name pair, or both, populated. This must correspond to a valid user in Document Server User Management.

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.

deleteReviewTemplate

()메서드 
public function deleteReviewTemplate(templateName:String):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

This API deletes a review template from the system.

매개 변수

templateName:String — The name of the template to be deleted.

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains a Boolean value, True on successful deletion and False otherwise.

exportAssetArchive

()메서드 
public function exportAssetArchive(reviewId:String, revision:int):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

This API returns the native review document, if present or the PDF file of the review document.

매개 변수

reviewId:String — A unique identifier of a review.
 
revision:int — The revision of the review.

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains the native file if it is present or else the PDF file of the review document.

getCommentsForParticipant

()메서드 
public function getCommentsForParticipant(reviewId:String, revision:int, stageNo:int, participantOid:String):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

This API retrieves the RSS file of comments, for a particular reviewer.

매개 변수

reviewId:String — The unique identifier for a review zone.
 
revision:int — The revision of the review
 
stageNo:int — The stage number of the review stage.
 
participantOid:String — The UMOID of the reviewer.

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains a file having the comment RSS.

getDocument

()메서드 
public function getDocument(reviewId:String, revision:int, documentPath:String):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

This API retrieves a file from the review zone associated with the provided review ID and revision.

매개 변수

reviewId:String — The unique identifier for a review zone.
 
revision:int — The revision of the review.
 
documentPath:String — The path at which the provided document must be stored. This path is a Unix-like path, that is, it contains forward slash points to root of the review zone. Hence, this path should start with a forward slash.

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains the file stored at the provided path.

getDocumentWithComments

()메서드 
public function getDocumentWithComments(reviewId:String, revision:int, stageNo:int):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

This API retrieves a review document with comments, from all reviewers of a review stage. Comments are embedded in the document (in XFDF format).

매개 변수

reviewId:String — The unique identifier for a review zone.
 
revision:int — The revision of the review.
 
stageNo:int — The stage number of the review stage.

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains the review document with comments (in XFDF format).

getReviewByProcessId

()메서드 
public function getReviewByProcessId(assignTaskPid:String):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

This operation retrieves the review context for a given process ID.

매개 변수

assignTaskPid:String — The unique process ID of the assign task operation.

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains the ReviewContextVO which triggered process with the passed process ID.

getReviewContext

()메서드 
public function getReviewContext(reviewId:String, revision:int):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

This operation returns ReviewContextVO for the specified review and revision of the review.

매개 변수

reviewId:String — Review identifier to uniquely identify the review.
 
revision:int — The revision number of the review.

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains the review context object.

getReviewTemplate

()메서드 
public function getReviewTemplate(templateName:String):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

This API fetches a ReviewTemplateVO from the system.

매개 변수

templateName:String — The name of the template to be fetched.

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains an object of ReviewTemplateVO.

getRevisions

()메서드 
public function getRevisions(reviewId:String):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

Searches for review revisions of the review specified by reviewId. Using this API, you can get all the information about a review and its revisions.

매개 변수

reviewId:String — The review ID for searching its revisions.

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains search results in the form of a list of ReviewContextVO. A ReviewContextVO in the returned list consists of all the details about the review.

getStageDocument

()메서드 
public function getStageDocument(reviewId:String, revision:int, stageNo:int):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

This API retrieves a prepared stage document. This document is provided to the non-moderator participants (reviewers, approvers, or author) of a stage.

매개 변수

reviewId:String — The unique identifier of a review zone.
 
revision:int — The revision of the review.
 
stageNo:int — The stage number inside the review

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains the file for the document.

getUserPreference

()메서드 
public function getUserPreference(domain:String, canonicalName:String):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

This operation gets the user preferences for a particular user.

매개 변수

domain:String — The domain name of the user.
 
canonicalName:String — The canonical name of the user.

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The result event contains an object of UserPreferenceVO type. A null is returned if no preference exists for a user.

initiateReview

()메서드 
public function initiateReview(reviewTemplate:com.adobe.solutions.rca.vo:ReviewTemplateVO, reviewDocument:File = null):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

This method initiates a multi-stage process consisting of a creation, a review, or an approval stages on an asset.

매개 변수

reviewTemplate:com.adobe.solutions.rca.vo:ReviewTemplateVO — An instance of the schedule template which contains the stages.
 
reviewDocument:File (default = null) — The PDF file which represents the asset.

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains review Id of the initiated review.

purgeReviews

()메서드 
public function purgeReviews(reviewIdList:IList, clearReviewZone:Boolean):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

This operation removes data for a particular review from the system. It does not purge the data of an ongoing review. An ongoing review is ignored and a warning is logged. A review must be completed, expired, or revoked, before this API is called. Only the users with RCA Administrator role can invoke this API.

매개 변수

reviewIdList:IList — A list of the IDs of the reviews to be purged.
 
clearReviewZone:Boolean — A Boolean flag. If the value is True then corresponding review zone folder is also deleted.

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains a list of IDs of the reviews that could not be purged.

removeParticipantFromStage

()메서드 
public function removeParticipantFromStage(reviewId:String, stageNo:int, stageParticipant:StageParticipantVO):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

This operation removes a non-moderator participant from an ongoing stage. The status of StageParticipantVO of the participant to be removed should be PENDING before calling this operation. In case of a parallel review or approval stage, it is possible that a reviewer or approver has completed the tasks before removal.

매개 변수

reviewId:String — The review identifier to uniquely identify the review.
 
stageNo:int — The stage number inside the review.
 
stageParticipant:StageParticipantVO — The stage participant to be removed.

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.

resolveStage

()메서드 
public function resolveStage(reviewId:String, stageNo:int):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

This API makes a reference stage inline. For a stage that is referring a stage template, this API can make it an inline stage.

매개 변수

reviewId:String — The unique identifier for a review.
 
stageNo:int — The number of the stage.

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.

reviseReview

()메서드 
public function reviseReview(reviewId:String, stageNo:int, reviewDocument:File, changeDescription:String):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

This operation generates a new revision of a review from a particular stage.

매개 변수

reviewId:String — The unique ID of the review.
 
stageNo:int — The identifier of the stage within the review.
 
reviewDocument:File — The new File to be used in the revision.
 
changeDescription:String — Description for this revision of the review.

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.

revokeReview

()메서드 
public function revokeReview(reviewId:String):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

This operation revokes the review specified by review identifier. Only a review which is currently running can be revoked.

매개 변수

reviewId:String — Review identifier to uniquely identify the review.

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.

searchReviews

()메서드 
public function searchReviews(reviewSearchFilter:ReviewSearchFilterVO):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

Searches for reviews as specified by the reviewSearchFilter.

매개 변수

reviewSearchFilter:ReviewSearchFilterVO — Filter to be applied while searching. All the attributes of reviewSearchFilter are considered together for search (equivalent to a logical AND operation).

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains the search results in the form of a list of ReviewContextVO. A ReviewContextVO in the returned list contains only the basic information about the review.

searchReviewTemplates

()메서드 
public function searchReviewTemplates(templateSearchFilter:com.adobe.solutions.rca.vo:TemplateSearchFilterVO):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

This API searchs for schedule templates in the system.

매개 변수

templateSearchFilter:com.adobe.solutions.rca.vo:TemplateSearchFilterVO — Filter to be applied while searching.

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached. The resulting event contains a list of ReviewTemplateVO.

setStageDisposition

()메서드 
public function setStageDisposition(reviewId:String, revision:int, stageNo:int, disposition:String):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

This API sets the disposition of a stage.

매개 변수

reviewId:String — The unique identifier of a review.
 
revision:int — The revision of the review.
 
stageNo:int — The stage number.
 
disposition:String — The disposition string.

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.

setUserPreference

()메서드 
public function setUserPreference(domain:String, canonicalName:String, userPreference:UserPreferenceVO):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

This operation sets the user preferences for a particular user. It replaces existing user preferences with a new set of preferences.

매개 변수

domain:String — The domain name of the user.
 
canonicalName:String — The canonical name of the user.
 
userPreference:UserPreferenceVO — An object of UserPreferenceVO type.

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.

storeContentInCRX

()메서드 
public function storeContentInCRX(absSpacePath:String, fileName:String, document:File, throwOsgiEventOnly:Boolean):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

This internal API stores a file in ADEP Content Repository.

매개 변수

absSpacePath:String — The absolute space path.
 
fileName:String — The file name.
 
document:File — The document to be stored.
 
throwOsgiEventOnly:Boolean — A flag to generate OSGi event, instead of storing the file.

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.

storeReviewTemplate

()메서드 
public function storeReviewTemplate(reviewTemplate:com.adobe.solutions.rca.vo:ReviewTemplateVO, overwrite:Boolean):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

This operation stores a ReviewTemplateVO in the system. A schedule name must be unique in the system, unless the intent is to overwrite a previously stored schedule with the same name.

매개 변수

reviewTemplate:com.adobe.solutions.rca.vo:ReviewTemplateVO — An instance of ReviewTemplateVO.
 
overwrite:Boolean — A Boolean value for error-proof overwriting of schedules. If the value is True and a template exists with same name, then the existing template is replaced with the provided reviewTemplate.

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.

toggleReviewerType

()메서드 
public function toggleReviewerType(reviewerId:String):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

This API is used to mark an optional reviewer mandatory and vice-versa.

매개 변수

reviewerId:String — The unique identifier of the reviewer.

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.

updateCustomAttributes

()메서드 
public function updateCustomAttributes(reviewId:String, revision:int, customAttributes:IList, discardOld:Boolean):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

This operation updates the searchable custom attributes of a review.

매개 변수

reviewId:String — The unique ID of the review.
 
revision:int — The revision of the review.
 
customAttributes:IList — A list of CustomAttributeVO.
 
discardOld:Boolean — A Boolean value to facilitate discarding old attributes. If True, the old custom attributes are discarded.

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.

updateStageDuration

()메서드 
public function updateStageDuration(reviewId:String, stageNo:int, duration:int, durationUnit:String):mx.rpc:AsyncToken

언어 버전: ActionScript 3.0
제품 버전: Review, Commenting, and Approval Building Block 10
런타임 버전: Flash Player 10.2, AIR (unsupported)

This operation updates the stage duration of an already running RCA Process. Stage duration can only be updated for:

  • The current revision of a review and approval process. Any future revisions, if any, have the updated duration.
  • The ongoing or any future stages of a review and approval process.

매개 변수

reviewId:String — The unique ID of the review. (required parameter)
 
stageNo:int — The ID of a stage within a review. (required parameter)
 
duration:int — New duration of the stage. (required parameter)
 
durationUnit:String — The unit of stage duration. Valid values for the duration are:
  • Minutes
  • Hours
  • Days (default value)
  • Business days

반환값
mx.rpc:AsyncToken — It returns a token on which success or failure handlers can be attached.




[ X ]영어로 표시되는 이유
ActionScript 3.0 참조 설명서의 내용이 영어로 나타납니다.

ActionScript 3.0 참조 설명서 중 일부는 전체 언어로 번역되지 않았습니다. 언어 요소가 번역되지 않은 경우 영어로 나타납니다. 예를 들어 ga.controls.HelpBox 클래스는 어떤 언어로도 번역되지 않았습니다. 그러므로 한국어 버전의 참조 설명서에서 ga.controls.HelpBox 클래스는 영어로 나타납니다.