lc.domain.SessionMap (Livecycle)

Package	lc.domain
Class	public class SessionMap
Inheritance	SessionMap Object

The SessionMap class provides untyped access to LiveCycle Workspace ES API objects and other singletons. For example, the session manager can be retrieved using the following code:

var sessionManager:ISessionManager = ISessionManager(session.getObject("lc.core.ISessionManager"));

Additional objects can be added using the setObject method. The general convention for key names is that the key name should match the fully qualified class or interface name that you want, as in the ISessionManager example above. In addition, it is possible to use typed convenience methods from the WorkspaceSession object to retrieve Workspace ES API objects.

The SessionMap object is initialized during the application initialization and passed to all components, as the session property, thereby making it available throughout the application.

See also

lc.domain.workspace.WorkspaceSession

	Property	Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		getObject(key:String):Object Retrieves a session object given a key.	SessionMap
		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
		setObject(key:String, object:Object):void Adds an object to be retrieved with the given key.	SessionMap
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object

Method Detail

getObject

()

method

public function getObject(key:String):Object

Retrieves a session object given a key.

Parameters

key:String — Specifies the key for the SessionMap object. The standard convention is that this will be the fully qualified name of the class or interface to which the returned object would be cast.

Returns

Object — An object matching the given key. If there is no match for the key, null is returned.

setObject

()

method

public function setObject(key:String, object:Object):void

Adds an object to be retrieved with the given key. If the object with that key already exists, it will be replaced.

Parameters

	`key:String` — Specifies the key for the object.

	`object:Object` — Specifies the object to be stored for the given key.

Livecycle ES API Reference	All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Frames No Frames
SessionMap	Properties \| Methods