| Package | lc.foundation.domain |
| Class | public class SessionMap |
| Inheritance | SessionMap  Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The SessionMap object is initialized during application initialization and passed
to all components, as the session property, therefore making it available throughout the
application.
It is recommended to use the typed convenience methods from the
WorkspaceSession object to retrieve Workspace API objects.
For example, if you want to use the QueuesManager object, it can be retrieved using the following code:
var queuesManager:QueuesManager = WorkspaceSession.getQueuesManager(session);
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.
For example, to add a new object to the session, your can use the following code:
session.setObject("my.example.ISample", new Sample());
This object may be retrieved from the session property using the following code:
var mySample:ISample =
ISample(session.getObject("my.example.ISample"));
For information on using this component to customize Workspace, see Customizing the Digital Enterprise Platform Document Services - Workspace 10.0 User Interface .
Related API Elements
| Property | Defined By | ||
|---|---|---|---|
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| Method | Defined By | ||
|---|---|---|---|
Retrieves a session object using the provided key. | SessionMap | ||
|
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 | |
Adds an object to be retrieved with the given key. | SessionMap | ||
|
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 | |
|
Returns the primitive value of the specified object. | Object | |
getObject | () | method |
public function getObject(key:String):Object| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Retrieves a session object using the provided 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.
|
Object — An object matching the given key. If no match for the key exists,
a value of null is returned.
|
setObject | () | method |
public function setObject(key:String, object:Object):void| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
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.
|
Related API Elements
Thu Dec 4 2014, 05:50 PM -08:00