ReviewContext

Package	com.adobe.solutions.rca.domain.impl
Class	public class ReviewContext
Inheritance	ReviewContext Object
Implements	IReviewContext, IEventDispatcher
Subclasses	ReviewTemplate

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10.0

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

This class defines the review context domain object.

Public Properties

	Property		Defined By
		additionalMetadata : String Any review-specific data can be preserved in this field.	ReviewContext
		allMemberList : IList [read-only] The property returns a collection of all members.	ReviewContext
		arsProcessName : String Name of the process used to generate Approval Routing Sheet (ARS).	ReviewContext
		auditLevel : String The level of audit associated with this review.	ReviewContext
		calculatedEndDate : Date The endDate if the review has ended.	ReviewContext
		calculatedStartDate : Date The startDate if the review has started.	ReviewContext
		changeDescription : String This field is used to store the change desciption, if a review is revised.	ReviewContext
		commentServerPath : String Server location where Adobe ® Acrobat ® stores the inline comments.	ReviewContext
		commentVisibility : String Adobe Acrobat's inline comment visibility across stages.	ReviewContext
		complianceCode : String Compliance code of the schedule template.	ReviewContext
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentRevision : Boolean A Boolean value to decide whether this is the current revision of the review or not.	ReviewContext
		currentStage : int Stage number in progress for this review (starts with 1).	ReviewContext
		customAttributes : IList List of custom attributes.	ReviewContext
		endDate : Date End date of a review.	ReviewContext
		ganttItems : ArrayCollection [read-only] A collection of the displayable children that are displayed in the Gantt chart if showChildren flag is set to True.	ReviewContext
		id : String [read-only] A unique identifier for this review version.	ReviewContext
		initiator : IInitiator Initiator of a review.	ReviewContext
		invocationId : String The ID of the invocation request when a review is initiated.	ReviewContext
		itemEndDate : Date [read-only] End date of the item.	ReviewContext
		itemName : String [read-only] Name of the item.	ReviewContext
		itemStartDate : Date [read-only] Start date of the item.	ReviewContext
		itemState : String [read-only] State of the item.	ReviewContext
		itemStatus : String [read-only] Status of the item.	ReviewContext
		itemType : String [read-only] Type of item.	ReviewContext
		largeThumbnail : File Large thumbnail image of a document under review.	ReviewContext
		memberList : IList [read-only] The property returns a collection of directly associated members.	ReviewContext
		nativeFileName : String Path of the file, in the content repository, on which the review is initiated.	ReviewContext
		operationList : ArrayCollection [read-only] A collection of operations that are available to a user through the context menu in the Gantt chart.	ReviewContext
		purpose : String Review purpose.	ReviewContext
		reviewCommentingAndApproval : IReviewCommentingAndApproval An instance of Review Commenting and Approval service for this review.	ReviewContext
		reviewId : String A unique identifier of the review.	ReviewContext
		reviewType : String Type of review like Regulated or Ad-hoc.	ReviewContext
		revision : int Review revision number.	ReviewContext
		rtsProcessName : String Name of the process used to generate Review Tracking Sheet (RTS).	ReviewContext
		showChildren : Boolean A Boolean flag to determine if the children need to be displayed.	ReviewContext
		showParent : Boolean A Boolean flag to determine if the parent needs to be displayed.	ReviewContext
		smallThumbnail : File Small thumbnail image of a document under review.	ReviewContext
		stageList : IList List of stages in a review.	ReviewContext
		startDate : Date Start date of a review.	ReviewContext
		status : String Review purpose.	ReviewContext
		stp : Boolean A Boolean field to enable or disable Straight Through Processing (STP).	ReviewContext
		supportingDocumentList : IList List of supporting documents for a review.	ReviewContext
		templateAuthor : String Name of the schedule template author.	ReviewContext
		templateDescription : String Description of the schedule template used to initiate this review.	ReviewContext
		title : String Review title.	ReviewContext
		uniqueMemberList : IList [read-only] The property returns a collection of unique members.	ReviewContext
		vo : ReviewContextVO The Value Object for this review version.	ReviewContext

Public Methods

	Method		Defined By
		ReviewContext(value:ReviewContextVO = null) The constructor for ReviewContext class.	ReviewContext
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	ReviewContext
		addMemberAndSave(member:IMember):mx.rpc:AsyncToken This remote operation adds a member to the collection and submits the change to the server.	ReviewContext
		addStage(stage:IStage):void Adds stage to the review after the last stage.	ReviewContext
		addStageAt(stage:IStage, index:int):void Adds stage to the review at the specified index from the beginning.	ReviewContext
		addSupportingDocument(doc:ISupportingDocument):void Adds the supporting document at the end of the list of supportingDocuments for this review.	ReviewContext
		addSupportingDocumentAt(doc:ISupportingDocument, index:int):void Adds the supporting document at the index in the list of supportingDocuments for this review.	ReviewContext
		calculateDates():void Populates the calculatedStartDate and calculatedEndDate fields.	ReviewContext
		clearIds():void Clears ID for a reviewContext object for persisting it at another location in the repository.	ReviewContext
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	ReviewContext
		fetchAssetArchive():mx.rpc:AsyncToken Returns an asset archive for this review.	ReviewContext
		fetchLargeThumbnail():mx.rpc:AsyncToken Returns largeThumbnail for this review version.	ReviewContext
		fetchNativeDocument():mx.rpc:AsyncToken Returns the original file submitted for review.	ReviewContext
		fetchReviewContext():mx.rpc:AsyncToken Returns the review context value object for this review.	ReviewContext
		fetchReviewDocument():mx.rpc:AsyncToken Returns the review document for this review.	ReviewContext
		fetchSmallThumbnail():mx.rpc:AsyncToken Returns smallThumbnail for this review version.	ReviewContext
		hasChildren():Boolean A Boolean function to determine if the item has displayable children.	ReviewContext
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	ReviewContext
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeAllStages():void Removes all stages from a review.	ReviewContext
		removeAllSupportingDocument():void Removes all supporting documents from the list of supportingDocuments for this review.	ReviewContext
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	ReviewContext
		removeMemberAndSave(member:IMember):mx.rpc:AsyncToken This remote operation removes a member from the collection and submits the change to the server.	ReviewContext
		removeStageAt(index:int):IStage Removes a stage at the specified index from the beginning of the review.	ReviewContext
		removeSupportingDocumentAt(index:int):ISupportingDocument Removes a supporting document at the index from the list of supportingDocuments for this review.	ReviewContext
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		updateTitleAndSave(member:IMember, title:String):mx.rpc:AsyncToken This remote operation updates the tile of a member present in collection and submits the change to the server.	ReviewContext
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	ReviewContext

Property Detail

additionalMetadata

property

additionalMetadata:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Any review-specific data can be preserved in this field.

Implementation
public function get additionalMetadata():String
public function set additionalMetadata(value:String):void

allMemberList

property

allMemberList:IList [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The property returns a collection of all members. It takes into consideration any child objects that may be of type IMemberCollection.

This property can be used as the source for data binding. When this property is modified, it dispatches the memberListChanged event.

Implementation
public function get allMemberList():IList

arsProcessName

property

arsProcessName:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Name of the process used to generate Approval Routing Sheet (ARS).

Implementation
public function get arsProcessName():String
public function set arsProcessName(value:String):void

auditLevel

property

auditLevel:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The level of audit associated with this review.

Implementation
public function get auditLevel():String
public function set auditLevel(value:String):void

calculatedEndDate

property

calculatedEndDate:Date

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The endDate if the review has ended. Otherwise the expected ended date.

Implementation
public function get calculatedEndDate():Date
public function set calculatedEndDate(value:Date):void

calculatedStartDate

property

calculatedStartDate:Date

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The startDate if the review has started. Otherwise the expected start date.

Implementation
public function get calculatedStartDate():Date
public function set calculatedStartDate(value:Date):void

changeDescription

property

changeDescription:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

This field is used to store the change desciption, if a review is revised.

Implementation
public function get changeDescription():String
public function set changeDescription(value:String):void

commentServerPath

property

commentServerPath:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Server location where Adobe ® Acrobat ® stores the inline comments.

Implementation
public function get commentServerPath():String
public function set commentServerPath(value:String):void

commentVisibility

property

commentVisibility:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Adobe Acrobat's inline comment visibility across stages.

Implementation
public function get commentVisibility():String
public function set commentVisibility(value:String):void

complianceCode

property

complianceCode:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Compliance code of the schedule template.

Implementation
public function get complianceCode():String
public function set complianceCode(value:String):void

currentRevision

property

currentRevision:Boolean

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

A Boolean value to decide whether this is the current revision of the review or not.

Implementation
public function get currentRevision():Boolean
public function set currentRevision(value:Boolean):void

currentStage

property

currentStage:int

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Stage number in progress for this review (starts with 1).

Implementation
public function get currentStage():int
public function set currentStage(value:int):void

customAttributes

property

customAttributes:IList

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

List of custom attributes.

Implementation
public function get customAttributes():IList
public function set customAttributes(value:IList):void

endDate

property

endDate:Date

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

End date of a review.

Implementation
public function get endDate():Date
public function set endDate(value:Date):void

ganttItems

property

ganttItems:ArrayCollection [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

A collection of the displayable children that are displayed in the Gantt chart if showChildren flag is set to True.

This property can be used as the source for data binding. When this property is modified, it dispatches the ganttItemsChanged event.

Implementation
public function get ganttItems():ArrayCollection

id

property

id:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

A unique identifier for this review version.

Implementation
public function get id():String

initiator

property

initiator:IInitiator

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Initiator of a review.

Implementation
public function get initiator():IInitiator
public function set initiator(value:IInitiator):void

invocationId

property

invocationId:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The ID of the invocation request when a review is initiated.

Implementation
public function get invocationId():String
public function set invocationId(value:String):void

itemEndDate

property

itemEndDate:Date [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

End date of the item.

Implementation
public function get itemEndDate():Date

itemName

property

itemName:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Name of the item.

Implementation
public function get itemName():String

itemStartDate

property

itemStartDate:Date [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Start date of the item.

Implementation
public function get itemStartDate():Date

itemState

property

itemState:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

State of the item.

Implementation
public function get itemState():String

itemStatus

property

itemStatus:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Status of the item.

Implementation
public function get itemStatus():String

itemType

property

itemType:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Type of item.

Implementation
public function get itemType():String

largeThumbnail

property

largeThumbnail:File

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Large thumbnail image of a document under review.

Implementation
public function get largeThumbnail():File
public function set largeThumbnail(value:File):void

memberList

property

memberList:IList [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The property returns a collection of directly associated members.

This property can be used as the source for data binding. When this property is modified, it dispatches the memberListChanged event.

Implementation
public function get memberList():IList

nativeFileName

property

nativeFileName:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Path of the file, in the content repository, on which the review is initiated.

Implementation
public function get nativeFileName():String
public function set nativeFileName(value:String):void

operationList

property

operationList:ArrayCollection [read-only]

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

A collection of operations that are available to a user through the context menu in the Gantt chart.

Implementation
public function get operationList():ArrayCollection

purpose

property

purpose:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Review purpose.

Implementation
public function get purpose():String
public function set purpose(value:String):void

reviewCommentingAndApproval

property

reviewCommentingAndApproval:IReviewCommentingAndApproval

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

An instance of Review Commenting and Approval service for this review.

Implementation
public function get reviewCommentingAndApproval():IReviewCommentingAndApproval
public function set reviewCommentingAndApproval(value:IReviewCommentingAndApproval):void

reviewId

property

reviewId:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

A unique identifier of the review.

Implementation
public function get reviewId():String
public function set reviewId(value:String):void

reviewType

property

reviewType:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Type of review like Regulated or Ad-hoc.

Implementation
public function get reviewType():String
public function set reviewType(value:String):void

revision

property

revision:int

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Review revision number.

Implementation
public function get revision():int
public function set revision(value:int):void

rtsProcessName

property

rtsProcessName:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Name of the process used to generate Review Tracking Sheet (RTS).

Implementation
public function get rtsProcessName():String
public function set rtsProcessName(value:String):void

showChildren

property

showChildren:Boolean

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

A Boolean flag to determine if the children need to be displayed.

Implementation
public function get showChildren():Boolean
public function set showChildren(value:Boolean):void

showParent

property

showParent:Boolean

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

A Boolean flag to determine if the parent needs to be displayed.

Implementation
public function get showParent():Boolean
public function set showParent(value:Boolean):void

smallThumbnail

property

smallThumbnail:File

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Small thumbnail image of a document under review.

Implementation
public function get smallThumbnail():File
public function set smallThumbnail(value:File):void

stageList

property

stageList:IList

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

List of stages in a review.

Implementation
public function get stageList():IList
public function set stageList(value:IList):void

startDate

property

startDate:Date

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Start date of a review.

Implementation
public function get startDate():Date
public function set startDate(value:Date):void

status

property

status:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Review purpose.

Implementation
public function get status():String
public function set status(value:String):void

stp

property

stp:Boolean

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

A Boolean field to enable or disable Straight Through Processing (STP).

Implementation
public function get stp():Boolean
public function set stp(value:Boolean):void

supportingDocumentList

property

supportingDocumentList:IList

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

List of supporting documents for a review.

Implementation
public function get supportingDocumentList():IList
public function set supportingDocumentList(value:IList):void

templateAuthor

property

templateAuthor:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Name of the schedule template author.

Implementation
public function get templateAuthor():String
public function set templateAuthor(value:String):void

templateDescription

property

templateDescription:String

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Description of the schedule template used to initiate this review.

Implementation
public function get templateDescription():String
public function set templateDescription(value:String):void

()

Constructor

public function ReviewContext(value:ReviewContextVO = null)

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 ReviewContext class.

Parameters

value:ReviewContextVO (default = null) — Review context value object.

Method Detail

addEventListener

()

method

 public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void

Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

After you successfully register an event listener, you cannot change its priority through additional calls to addEventListener(). To change a listener's priority, you must first call removeEventListener(). Then you can register the listener again with the new priority level.

After the listener is registered, subsequent calls to addEventListener() with a different value for either type or useCapture result in the creation of a separate listener registration. For example, if you first register a listener with useCapture set to true, it listens only during the capture phase. If you call addEventListener() again using the same listener object, but with useCapture set to false, you have two separate listeners: one that listens during the capture phase, and another that listens during the target and bubbling phases.

You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.

When you no longer need an event listener, remove it by calling EventDispatcher.removeEventListener(); otherwise, memory problems might result. Objects with registered event listeners are not automatically removed from memory because the garbage collector does not remove objects that still have references.

Copying an EventDispatcher instance does not copy the event listeners attached to it. (If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.

If the event listener is being registered on a node while an event is also being processed on this node, the event listener is not triggered during the current phase but may be triggered during a later phase in the event flow, such as the bubbling phase.

If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again (unless it is registered again for future processing).

Parameters

	`type:String` — The type of event.

	`listener:Function` — The listener function that processes the event. This function must accept an event object as its only parameter and must return nothing, as this example shows: `function(evt:Event):void` The function can have any name.

	`useCapture:Boolean` (default = `false`) — Determines whether the listener works in the capture phase or the target and bubbling phases. If `useCapture` is set to `true`, the listener processes the event only during the capture phase and not in the target or bubbling phase. If `useCapture` is `false`, the listener processes the event only during the target or bubbling phase. To listen for the event in all three phases, call `addEventListener()` twice, once with `useCapture` set to `true`, then again with `useCapture` set to `false`.

	`priority:int` (default = `0`) — The priority level of the event listener. Priorities are designated by a 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0.

	`weakRef:Boolean` (default = `false`) — Determines whether the reference to the listener is strong or weak. A strong reference (the default) prevents your listener from being garbage-collected. A weak reference does not. Class-level member functions are not subject to garbage collection, so you can set `useWeakReference` to `true` for class-level member functions without subjecting them to garbage collection. If you set `useWeakReference` to `true` for a listener that is a nested inner function, the function will be garbge-collected and no longer persistent. If you create references to the inner function (save it in another variable) then it is not garbage-collected and stays persistent.

addMemberAndSave

()

method

public function addMemberAndSave(member:IMember):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 remote operation adds a member to the collection and submits the change to the server.

Parameters

member:IMember — The member to be added to member collection.

Returns

mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached.

addStage

()

method

public function addStage(stage:IStage):void

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Adds stage to the review after the last stage.

Parameters

stage:IStage — Stage instance that needs to be added.

addStageAt

()

method

public function addStageAt(stage:IStage, index:int):void

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Adds stage to the review at the specified index from the beginning.

Parameters

	`stage:IStage` — `Stage` instance that needs to be added.

	`index:int` — Index at which this stage needs to be added.

addSupportingDocument

()

method

public function addSupportingDocument(doc:ISupportingDocument):void

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Adds the supporting document at the end of the list of supportingDocuments for this review.

Parameters

doc:ISupportingDocument — Supporting document that needs to be added.

addSupportingDocumentAt

()

method

public function addSupportingDocumentAt(doc:ISupportingDocument, index:int):void

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Adds the supporting document at the index in the list of supportingDocuments for this review.

Parameters

	`doc:ISupportingDocument` — Supporting document that needs to be added.

	`index:int` — Index at which the supporting document needs to be added.

calculateDates

()

method

public function calculateDates():void

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Populates the calculatedStartDate and calculatedEndDate fields.

clearIds

()

method

public function clearIds():void

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

()

method

public function hasEventListener(type:String):Boolean

Checks whether the EventDispatcher object has any listeners registered for a specific type of event. This allows you to determine where an EventDispatcher object has altered handling of an event type in the event flow hierarchy. To determine whether a specific event type will actually trigger an event listener, use IEventDispatcher.willTrigger().

The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.

Parameters

type:String — The type of event.

Returns

Boolean — A value of true if a listener of the specified type is registered; false otherwise.

removeAllStages

()

method

public function removeAllStages():void

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Removes all stages from a review.

removeAllSupportingDocument

()

method

public function removeAllSupportingDocument():void

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Removes all supporting documents from the list of supportingDocuments for this review.

removeEventListener

()

method

public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.

Parameters

	`type:String` — The type of event.

	`listener:Function` — The listener object to remove.

	`useCapture:Boolean` (default = `false`) — Specifies whether the listener was registered for the capture phase or the target and bubbling phases. If the listener was registered for both the capture phase and the target and bubbling phases, two calls to `removeEventListener()` are required to remove both: one call with `useCapture` set to `true`, and another call with `useCapture` set to `false`.

removeMemberAndSave

()

method

public function removeMemberAndSave(member:IMember):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 remote operation removes a member from the collection and submits the change to the server.

Parameters

member:IMember — The member to be removed from member collection.

Returns

mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached.

removeStageAt

()

method

public function removeStageAt(index:int):IStage

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Removes a stage at the specified index from the beginning of the review. Returns the removed stage.

Parameters

index:int — The index of the stage that needs to be removed.

Returns

IStage — Stage instance that has been removed.

removeSupportingDocumentAt

()

method

public function removeSupportingDocumentAt(index:int):ISupportingDocument

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

Removes a supporting document at the index from the list of supportingDocuments for this review.

Parameters

index:int — Index of the supporting document that needs to be removed.

Returns

ISupportingDocument — Supporting document that has been removed.

updateTitleAndSave

()

method

public function updateTitleAndSave(member:IMember, title: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 remote operation updates the tile of a member present in collection and submits the change to the server.

Parameters

	`member:IMember` — The member to be removed from member collection.

	`title:String` — The title of the member.

Returns

mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached.

willTrigger

()

method

public function willTrigger(type:String):Boolean

Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. This method returns true if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this EventDispatcher object or any of its descendants.

Parameters

type:String — The type of event.

Returns

Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.

Legal Notices | Online Privacy Policy

ReviewContext - AS3 Review, Commenting, and Approval

Classes x

additionalMetadata

allMemberList

arsProcessName

auditLevel

calculatedEndDate

calculatedStartDate

changeDescription

commentServerPath

commentVisibility

complianceCode

currentRevision

currentStage

customAttributes

endDate

ganttItems

id

initiator

invocationId

itemEndDate

itemName

itemStartDate

itemState

itemStatus

itemType

largeThumbnail

memberList

nativeFileName

operationList

purpose

reviewCommentingAndApproval

reviewId

reviewType

revision

rtsProcessName

showChildren

showParent

smallThumbnail

stageList

startDate

status

stp

supportingDocumentList

templateAuthor

templateDescription

title

uniqueMemberList

vo

ReviewContext

addEventListener

addMemberAndSave

addStage

addStageAt

addSupportingDocument

addSupportingDocumentAt

calculateDates

clearIds

dispatchEvent

fetchAssetArchive

fetchLargeThumbnail

fetchNativeDocument

fetchReviewContext

fetchReviewDocument

fetchSmallThumbnail

hasChildren

hasEventListener

removeAllStages

removeAllSupportingDocument

removeEventListener

removeMemberAndSave

removeStageAt

removeSupportingDocumentAt

updateTitleAndSave

willTrigger