StageTemplateVO

Package	com.adobe.solutions.rca.vo
Class	public class StageTemplateVO
Inheritance	StageTemplateVO ReviewStageVO NamedVO BaseVO Object
Implements	IManaged

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

This object holds the information of a stage template.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		active : Boolean A Boolean flag to determine if template is active or not.	StageTemplateVO
		additionalMetadata : String This property can be used to store additional metadata, while extending the application.	ReviewStageVO
		assignTaskToInitiatorProcess : String Process that can be used to override the default AssignTaskToInitiator process.	ReviewStageVO
		assignTaskToParticipantProcess : String Process that can be used to override the default AssignTaskToParticipant process.	ReviewStageVO
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		createdBy : String Name of the user who created the template.	StageTemplateVO
		createdOn : Date The date on which the template was created.	StageTemplateVO
		description : String Description of the template.	StageTemplateVO
		disposition : String This property can be used to store custom status for the stage.	ReviewStageVO
		duration : int Duration determines the time period after which a stage expires.	ReviewStageVO
		durationUnit : String Duration unit determines the unit for duration field.	ReviewStageVO
		endDate : Date Date on which the stage execution ended.	ReviewStageVO
		entityPath : String Gets the entity name in the content repository.	NamedVO
		id : String Get the ID of the VO.	BaseVO
		lastModifiedBy : String Name of the user who last modified the template.	StageTemplateVO
		lastModifiedOn : Date The date on which the template was last modified.	StageTemplateVO
		name : String The name of the stage.	ReviewStageVO
		nonExpiringStage : Boolean This Boolean flag determines the post-expiry behaviour of the stage.	ReviewStageVO
		participants : IList This property holds the collection of participants for this stage.	ReviewStageVO
		postProcessHookName : String Post-process hook is a process that is executed after a stage ends.	ReviewStageVO
		preProcessHookName : String Pre-process hook is a process that is executed before the start of a stage.	ReviewStageVO
		reference : Boolean A Boolean flag to indicate whether this stage is a reference to a stage template or not.	ReviewStageVO
		reminders : IList This property holds the collection of reminders associated with this stage.	ReviewStageVO
		requiresInitiatorReview : Boolean A Boolean flag to indicate whether an initiator review is required in a creation stage, after a collateral is produced, or not.	ReviewStageVO
		resolved : Boolean This Boolean flag indicates whether the reference has been resolved, if this stage is a reference to a stage template.	ReviewStageVO
		reviewContext : ReviewContextVO Review context object for this review stage.	ReviewStageVO
		signatureType : String Type of digital signature required for an approval stage.	ReviewStageVO
		stageNo : int Number of stage in the schedule.	ReviewStageVO
		startDate : Date Date on which the stage execution started.	ReviewStageVO
		status : String Status of the stage.	ReviewStageVO
		taskType : String This property determines the mechanism of task delivery to participants.	ReviewStageVO
		type : String This property defines the type of the stage.	ReviewStageVO
		waitForExpiry : Boolean If this Boolean flag is set to True, the stage waits for the complete duration even if all the stage participants have completed their tasks.	ReviewStageVO

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		StageTemplateVO() The constructor for StageTemplateVO class.	StageTemplateVO
		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.	StageTemplateVO
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	StageTemplateVO
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	StageTemplateVO
		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
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	StageTemplateVO
		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
		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.	StageTemplateVO

Property Detail

active

property

active: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 template is active or not.

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

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

createdBy

property

createdBy: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 user who created the template.

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

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

createdOn

property

createdOn:Date

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The date on which the template was created.

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

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

description

property

description: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 template.

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

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

lastModifiedBy

property

lastModifiedBy: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 user who last modified the template.

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

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

lastModifiedOn

property

lastModifiedOn:Date

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The date on which the template was last modified.

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

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

Constructor Detail

()

Constructor

public function StageTemplateVO()

Language Version:

ActionScript 3.0

Product Version:

Review, Commenting, and Approval Building Block 10

Runtime Versions:

Flash Player 10.2, AIR (unsupported)

The constructor for StageTemplateVO class.

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.

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.

Returns

Boolean — A value of true unless preventDefault() is called on the event, in which case it returns false.

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.

Returns

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

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

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.

StageTemplateVO - AS3 Review, Commenting, and Approval

Classes x

active

createdBy

createdOn

description

lastModifiedBy

lastModifiedOn