| 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) |
Hide Inherited Public Properties
Show Inherited 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 | ||
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| 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 | ||
| 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 | ||
This remote operation adds a member to the collection and submits the change to the server. | ReviewContext | ||
Adds stage to the review after the last stage. | ReviewContext | ||
Adds stage to the review at the specified index from the beginning. | ReviewContext | ||
Adds the supporting document at the end of the list of supportingDocuments for this review. | ReviewContext | ||
Adds the supporting document at the index in the list of supportingDocuments for this review. | ReviewContext | ||
Populates the calculatedStartDate and calculatedEndDate fields. | ReviewContext | ||
Clears ID for a reviewContext object for persisting it at another location in the repository. | ReviewContext | ||
Dispatches an event into the event flow. | ReviewContext | ||
Returns an asset archive for this review. | ReviewContext | ||
Returns largeThumbnail for this review version. | ReviewContext | ||
Returns the original file submitted for review. | ReviewContext | ||
Returns the review context value object for this review. | ReviewContext | ||
Returns the review document for this review. | ReviewContext | ||
Returns smallThumbnail for this review version. | ReviewContext | ||
A Boolean function to determine if the item has displayable children. | ReviewContext | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | ReviewContext | ||
|
Indicates whether an object has a specified property defined. | Object | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
Removes all stages from a review. | ReviewContext | ||
Removes all supporting documents from the list of supportingDocuments for this review. | ReviewContext | ||
Removes a listener from the EventDispatcher object. | ReviewContext | ||
This remote operation removes a member from the collection and submits the change to the server. | ReviewContext | ||
Removes a stage at the specified index from the beginning of the review. | ReviewContext | ||
Removes a supporting document at the index from the list of supportingDocuments for this review. | ReviewContext | ||
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
This remote operation updates the tile of a member present in collection and submits the change to the server. | ReviewContext | ||
|
Returns the primitive value of the specified object. | Object | |
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | ReviewContext | ||
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):voidallMemberList | 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():IListarsProcessName | 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):voidauditLevel | 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):voidcalculatedEndDate | 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):voidcalculatedStartDate | 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):voidchangeDescription | 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):voidcommentServerPath | 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):voidcommentVisibility | 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):voidcomplianceCode | 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):voidcurrentRevision | 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):voidcurrentStage | 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):voidcustomAttributes | 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):voidendDate | property |
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():ArrayCollectionid | property |
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):voidinvocationId | 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):voiditemEndDate | property |
itemName | property |
itemStartDate | property |
itemState | property |
itemStatus | property |
itemType | property |
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):voidmemberList | 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():IListnativeFileName | 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):voidoperationList | 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():ArrayCollectionpurpose | property |
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):voidreviewId | 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):voidreviewType | 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):voidrevision | property |
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):voidshowChildren | 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):voidshowParent | 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):voidsmallThumbnail | 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):voidstageList | property |
startDate | property |
status | property |
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):voidsupportingDocumentList | 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):voidtemplateAuthor | 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):voidtemplateDescription | 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):voidtitle | property |
uniqueMemberList | property |
uniqueMemberList: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 unique 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 uniqueMemberList():IListvo | property |
vo:ReviewContextVO| Language Version: | ActionScript 3.0 |
| Product Version: | Review, Commenting, and Approval Building Block 10 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
The Value Object for this review version.
Implementation
public function get vo():ReviewContextVO public function set vo(value:ReviewContextVO):voidReviewContext | () | 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.
value:ReviewContextVO (default = null) |
addEventListener | () | method |
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):voidRegisters 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:
| |
useCapture:Boolean (default = false)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) | |
weakRef:Boolean (default = false)Class-level member functions are not subject to garbage
collection, so you can set |
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.
|
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 |
| Runtime Versions: | Flash Player 10.2, AIR (unsupported) |
Clears ID for a reviewContext object for persisting it at another location in the repository.
dispatchEvent | () | method |
public function dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow. The event target is the
EventDispatcher object upon which dispatchEvent() is called.
Parameters
event:Event — The event object dispatched into the event flow.
|
Boolean — A value of true unless preventDefault() is called on the event,
in which case it returns false.
|
fetchAssetArchive | () | method |
public function fetchAssetArchive():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) |
Returns an asset archive for this review.
Returnsmx.rpc:AsyncToken — It returns a token on which success on fault handlers can be attached. The resulting event contains the asset archive for this review.
|
fetchLargeThumbnail | () | method |
public function fetchLargeThumbnail():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) |
Returns largeThumbnail for this review version.
mx.rpc:AsyncToken — It returns a token on which success on fault handlers can be attached. The resulting event contains largeThumbnail for this review version.
|
fetchNativeDocument | () | method |
public function fetchNativeDocument():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) |
Returns the original file submitted for review.
Returnsmx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains original file submitted for review.
|
fetchReviewContext | () | method |
public function fetchReviewContext():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) |
Returns the review context value object for this review.
Returnsmx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains review context value object for this review.
|
fetchReviewDocument | () | method |
public function fetchReviewDocument():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) |
Returns the review document for this review.
Returnsmx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains review document for this review.
|
fetchSmallThumbnail | () | method |
public function fetchSmallThumbnail():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) |
Returns smallThumbnail for this review version.
mx.rpc:AsyncToken — It returns a token on which success or fault handlers can be attached. The resulting event contains smallThumbnail for this review version.
|
hasChildren | () | method |
public function hasChildren():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 function to determine if the item has displayable children.
ReturnsBoolean — It returns a True value if there are displayable children.
|
hasEventListener | () | 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.
|
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):voidRemoves 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)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.
|
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.
|
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.
|
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.
|
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.
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.
|
Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.
|
Mon Nov 28 2011, 06:48 AM -08:00