Packagelc.domain
Classpublic class ProcessVariable
InheritanceProcessVariable Inheritance Object
Implements IWorkspaceManaged

The ProcessVariable class represents the information stored as part of a process variable in LiveCycle ES and is used for retrieving the information for a process variable.



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  description : String
The description of the process variable.
ProcessVariable
  name : String
The name of the process variable.
ProcessVariable
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  searchable : Boolean
A flag that specifies whether the process variable is searchable.
ProcessVariable
  session : SessionMap
[read-only] A SessionMap object that stores information relating to the server session.
ProcessVariable
  title : String
The title of the process variable.
ProcessVariable
  type : String
The type of the process variable.
ProcessVariable
  value : Object
The value of the process variable.
ProcessVariable
  visible : Boolean
A flag that indicates whether a variable is visible.
ProcessVariable
Public Methods
 MethodDefined By
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
  
Sets the SessionMap object that stores the information relating to the server session.
ProcessVariable
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail
descriptionproperty
description:String  [read-write]

The description of the process variable.


Implementation
    public function get description():String
    public function set description(value:String):void
nameproperty 
name:String  [read-write]

The name of the process variable.


Implementation
    public function get name():String
    public function set name(value:String):void
searchableproperty 
searchable:Boolean  [read-write]

A flag that specifies whether the process variable is searchable.


Implementation
    public function get searchable():Boolean
    public function set searchable(value:Boolean):void
sessionproperty 
session:SessionMap  [read-only]

A SessionMap object that stores information relating to the server session.


Implementation
    public function get session():SessionMap

See also

titleproperty 
title:String  [read-write]

The title of the process variable.


Implementation
    public function get title():String
    public function set title(value:String):void
typeproperty 
type:String  [read-write]

The type of the process variable.


Implementation
    public function get type():String
    public function set type(value:String):void
valueproperty 
value:Object  [read-write]

The value of the process variable.


Implementation
    public function get value():Object
    public function set value(value:Object):void
visibleproperty 
visible:Boolean  [read-write]

A flag that indicates whether a variable is visible.


Implementation
    public function get visible():Boolean
    public function set visible(value:Boolean):void
Method Detail
setSession()method
public function setSession(session:SessionMap):void

Sets the SessionMap object that stores the information relating to the server session.

Parameters

session:SessionMap — Specifies the information relating to the server session.





 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/common/langref/lc/domain/ProcessVariable.html