coldfusion.air.Session (ColdFusion 9)

	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

	Method	Defined By
		Session(dbfile:File, syncManager:SyncManager, id:uint) Creates an instance of the Session class.	Session
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with the Session object so that the listener receives notification of an event.	Session
		beginTransaction(option:String = null):coldfusion.air:SessionToken Begins a transaction on the session.	Session
		close():coldfusion.air:SessionToken Closes the session by clearing the internal cache and closing the SqlConnection.	Session
		commit(ignoreLazyLoad:Boolean = false):coldfusion.air:SessionToken Commits the changes that have happened to the local database since the last fetch.	Session
		commitTransaction():coldfusion.air:SessionToken Commits the changes in the transaction.	Session
		dispatchEvent(evt:Event):Boolean Dispatches an event into the event flow.	Session
		getConnection():SQLConnection Returns the SQLConnection being used by the session.	Session
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	Session
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isCommitRequired():coldfusion.air:SessionToken Determines whether a commit must be called on the session to commit any pending operations to the server.	Session
		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
		keepAllServerObjects(coll:ArrayCollection):coldfusion.air:SessionToken Replaces the object in the local database with the corresponding server object for each element in the ArrayCollection of conflict instances.	Session
		keepServerObject(conflict:Conflict):coldfusion.air:SessionToken Replaces the client object instance that is in conflict with the corresponding server instance specified in the conflict object with the server instance in the local database.	Session
		lazyLoad(obj:Object, lazyFieldName:String):coldfusion.air:SessionToken Loads the object with the specified lazy field name.	Session
		load(cls:Class, obj:Object, ignoreLazyLoad:Boolean = false):coldfusion.air:SessionToken Takes objects of key-value pairs as criteria and returns an arraycollection matching the specified criteria.	Session
		loadAll(cls:Class, ignoreLazyLoad:Boolean = false):coldfusion.air:SessionToken Loads all the instances of a particular Class from the database.	Session
		loadByPK(cls:Class, obj:Object, ignoreLazyLoad:Boolean = false):coldfusion.air:SessionToken Loads a specific instance specified by the primary key-value pairs passed in the second parameter.	Session
		loadByQuery(cls:Class, sqlCondition:String, ignoreLazyLoad:Boolean = false):coldfusion.air:SessionToken Loads instances of the type cls by taking the SQL condition for the WHERE clause to filter the instances.	Session
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		remove(obj:Object):coldfusion.air:SessionToken Removes the object instance passed to the fucntion from the database.	Session
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	Session
		resetTrackingChanges(className:String = null):coldfusion.air:SessionToken Resets all the changes tracked in the offline AIR application.	Session
		rollbackTransaction():coldfusion.air:SessionToken Rolls the changes in the transaction back to the state before the transaction.	Session
		save(obj:Object):coldfusion.air:SessionToken Saves an instance of the object in the local database.	Session
		saveCache(coll:ArrayCollection):coldfusion.air:SessionToken Saves in the local database an ArrayCollection of data instances returned by the server CFC fetch method.	Session
		saveCacheObject(obj:Object):coldfusion.air:SessionToken Saves a single object instance in the local database.	Session
		saveUpdate(saveObj:Object):coldfusion.air:SessionToken Checks if the object specified in the parameter exists in the database.	Session
		saveUpdateCache(coll:ArrayCollection):coldfusion.air:SessionToken Saves or updates in the local database tan ArrayCollection of data instances returned by the server CFC fetch method.	Session
		saveUpdateCacheObject(obj:Object):coldfusion.air:SessionToken Saves or updates in the local database a data instance returned by the server CFC fetch method.	Session
		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
		update(obj:Object):coldfusion.air:SessionToken Updates the instance passed to it in the database.	Session
		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.	Session

Constructor Detail

Session

()

Constructor

public function Session(dbfile:File, syncManager:SyncManager, id:uint)

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Creates an instance of the Session class.

Parameters

	`dbfile:File` — File handler for the offline sqlite database file.

	`syncManager:SyncManager` — Instance of the SyncManager class.

	`id:uint` — Integer ID to create a unique session for the offline sqlite database. Use this ID to ensure that the correct sqlite database is used for each client-side transaction.

Method Detail

addEventListener

()

method

 public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Registers an event listener object with the Session object so that the listener receives notification of an event.

Parameters

	`type:String` — String that specifies the type of the event.

	`listener:Function` — The listener function that processes the event.

	`useCapture:Boolean` (default = `false`) — Determines whether the listener works in the capture phase or the target and bubbling phases.

	`priority:int` (default = `0`) — The priority level of the event listener.

	`useWeakReference:Boolean` (default = `false`) — Determines whether the reference to the listener is strong or weak.

beginTransaction

()

method

public function beginTransaction(option:String = null):coldfusion.air:SessionToken

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Begins a transaction on the session.

Parameters

option:String (default = null) — Indicates the locking strategy that is used by the transaction. The value can be one of the constants defined in the SQLTransactionLockType class: DEFERRED (the default) indicates that a lock is not acquired until the first read or write operation. EXCLUSIVE indicates that a lock is acquired as soon as possible, and no other SQLConnection instance can read from or write to the database. IMMEDIATE indicates that a lock is acquired as soon as possible, in which other SQLConnection instances can read from but can't write to the database.

Returns

coldfusion.air:SessionToken — The session token associated with the call

()

method

public function close():coldfusion.air:SessionToken

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Closes the session by clearing the internal cache and closing the SqlConnection. Match each openSession call on the syncManager with a corresponding close call on the session.

Returns

coldfusion.air:SessionToken — The session token associated with the call.

commit

()

method

public function commit(ignoreLazyLoad:Boolean = false):coldfusion.air:SessionToken

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Commits the changes that have happened to the local database since the last fetch.

Parameters

ignoreLazyLoad:Boolean (default = false) — Loads complete instances plus the chain of related objects by ignoring any fetchType of lazyload defined in the metadata.

Returns

coldfusion.air:SessionToken — The session token associated with the call.

commitTransaction

()

method

public function commitTransaction():coldfusion.air:SessionToken

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Commits the changes in the transaction.

Returns

coldfusion.air:SessionToken — The session token associated with the call.

dispatchEvent

()

method

public function dispatchEvent(evt:Event):Boolean

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Dispatches an event into the event flow. The event target is the EventDispatcher object upon which the dispatchEvent() method is called.

Parameters

evt:Event — The Event object that is dispatched into the event flow. If the event is being redispatched, a clone of the event is created automatically. After an event is dispatched, its target property cannot be changed, so you must create a new copy of the event for redispatching to work.

Returns

Boolean — A value of true if the event was successfully dispatched. A value of false indicates failure or that preventDefault() was called on the event.

dispatchSessionResultEvent

()

method

cfair_internal function dispatchSessionResultEvent(result:Object, token:coldfusion.air:SessionToken):void

Parameters

	`result:Object`

	`token:coldfusion.air:SessionToken`

getConnection

()

method

public function getConnection():SQLConnection

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Returns the SQLConnection being used by the session.

Returns

SQLConnection

hasEventListener

()

method

public function hasEventListener(type:String):Boolean

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Checks whether the EventDispatcher object has any listeners registered for a specific type of event.

Parameters

type:String — The type of event.

Returns

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

isCommitRequired

()

method

public function isCommitRequired():coldfusion.air:SessionToken

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Determines whether a commit must be called on the session to commit any pending operations to the server. The result received by a SessionResultEvent event is a Boolean value specifying if the commit is needed.

Returns

coldfusion.air:SessionToken — The session token associated with the call.

keepAllServerObjects

()

method

public function keepAllServerObjects(coll:ArrayCollection):coldfusion.air:SessionToken

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Replaces the object in the local database with the corresponding server object for each element in the ArrayCollection of conflict instances.

Parameters

coll:ArrayCollection — Array collection of Conflict objects returned by the ColdFusion server.

Returns

coldfusion.air:SessionToken — The session token associated with the call.

keepServerObject

()

method

public function keepServerObject(conflict:Conflict):coldfusion.air:SessionToken

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Replaces the client object instance that is in conflict with the corresponding server instance specified in the conflict object with the server instance in the local database.

Parameters

conflict:Conflict — Conflict object returned by the ColdFusion server.

Returns

coldfusion.air:SessionToken — The session token associated with the call.

lazyLoad

()

method

public function lazyLoad(obj:Object, lazyFieldName:String):coldfusion.air:SessionToken

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Loads the object with the specified lazy field name.

Parameters

	`obj:Object` — The object to be loaded.

	`lazyFieldName:String` — Property name of the nested object that needs to be loaded.

Returns

coldfusion.air:SessionToken — The session token associated with the call.

load

()

method

public function load(cls:Class, obj:Object, ignoreLazyLoad:Boolean = false):coldfusion.air:SessionToken

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Takes objects of key-value pairs as criteria and returns an arraycollection matching the specified criteria.

Parameters

	`cls:Class` — Class object of the ActionScript type.

	`obj:Object` — Specifies the key-value pairs for which to find matching instances.

	`ignoreLazyLoad:Boolean` (default = `false`) — Loads complete instances plus the chain of related objects by ignoring any fetchType of lazyload defined in the metadata.

Returns

coldfusion.air:SessionToken — The session token associated with the call.

loadAll

()

method

public function loadAll(cls:Class, ignoreLazyLoad:Boolean = false):coldfusion.air:SessionToken

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Loads all the instances of a particular Class from the database.

Parameters

	`cls:Class` — Class object of the ActionScript type.

	`ignoreLazyLoad:Boolean` (default = `false`) — Loads complete instances plus the chain of related objects by ignoring any fetchType of lazyload defined in the metadata.

Returns

coldfusion.air:SessionToken — The session token associated with the call.

loadByPK

()

method

public function loadByPK(cls:Class, obj:Object, ignoreLazyLoad:Boolean = false):coldfusion.air:SessionToken

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Loads a specific instance specified by the primary key-value pairs passed in the second parameter.

Parameters

	`cls:Class` — Class object of the ActionScript type.

	`obj:Object` — Map of id fields and its values

	`ignoreLazyLoad:Boolean` (default = `false`) — Loads complete instances plus the chain of related objects by ignoring any fetchType of lazyload defined in the metadata.

Returns

coldfusion.air:SessionToken — The session token associated with the call.

loadByQuery

()

method

public function loadByQuery(cls:Class, sqlCondition:String, ignoreLazyLoad:Boolean = false):coldfusion.air:SessionToken

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Loads instances of the type cls by taking the SQL condition for the WHERE clause to filter the instances.

Parameters

	`cls:Class` — Class object of the ActionScript type.

	`sqlCondition:String` — The SQL condition to match.

	`ignoreLazyLoad:Boolean` (default = `false`) — Loads complete instances plus the chain of related objects by ignoring any fetchType of lazyload defined in the metadata.

Returns

coldfusion.air:SessionToken — The session token associated with the call.

remove

()

method

public function remove(obj:Object):coldfusion.air:SessionToken

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Removes the object instance passed to the fucntion from the database. Corresponds to a SQL DELETE operation.

Parameters

obj:Object — The object to delete in the local database.

Returns

coldfusion.air:SessionToken — The session token associated with the call.

removeEventListener

()

method

public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

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

resetTrackingChanges

()

method

public function resetTrackingChanges(className:String = null):coldfusion.air:SessionToken

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Resets all the changes tracked in the offline AIR application.

Parameters

className:String (default = null) — A fully qualified class name. When you pass this parameter, the resetTrackingChanges function resets all the changes tracked for all instances of the class name being passed.

Returns

coldfusion.air:SessionToken — The session token associated with the call.

rollbackTransaction

()

method

public function rollbackTransaction():coldfusion.air:SessionToken

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Rolls the changes in the transaction back to the state before the transaction.

Returns

coldfusion.air:SessionToken — The session token associated with the call.

save

()

method

public function save(obj:Object):coldfusion.air:SessionToken

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Saves an instance of the object in the local database. Corresponds to a SQL INSERT operation.

Parameters

obj:Object — The object to save in the local database.

Returns

coldfusion.air:SessionToken — The session token associated with the call.

saveCache

()

method

public function saveCache(coll:ArrayCollection):coldfusion.air:SessionToken

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Saves in the local database an ArrayCollection of data instances returned by the server CFC fetch method.

Parameters

coll:ArrayCollection — Array collection of the server objects.

Returns

coldfusion.air:SessionToken — The session token associated with the call.

saveCacheObject

()

method

public function saveCacheObject(obj:Object):coldfusion.air:SessionToken

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Saves a single object instance in the local database. This is an alternative to saveCache function that you can use if the fetch method returns a single result. This function differs from Save function. The Save function inserts a new record, whereas this method copies the object from server to the local database.

Parameters

obj:Object

Returns

coldfusion.air:SessionToken — The session token associated with the call.

saveCacheObjectCallCache

()

method

cfair_internal function saveCacheObjectCallCache(obj:Object, callCache:Object):coldfusion.air:SessionToken

Parameters

	`obj:Object`

	`callCache:Object`

Returns

coldfusion.air:SessionToken

saveUpdate

()

method

public function saveUpdate(saveObj:Object):coldfusion.air:SessionToken

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Checks if the object specified in the parameter exists in the database. If it does exists, updates the object; otherwise, it inserts the object in the database.

Parameters

saveObj:Object — The object to save or update in the local database.

Returns

coldfusion.air:SessionToken — The session token associated with the call.

saveUpdateCache

()

method

public function saveUpdateCache(coll:ArrayCollection):coldfusion.air:SessionToken

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Saves or updates in the local database tan ArrayCollection of data instances returned by the server CFC fetch method.

Parameters

coll:ArrayCollection — Array collection of the server objects.

Returns

coldfusion.air:SessionToken — The session token associated with the call.

saveUpdateCacheObject

()

method

public function saveUpdateCacheObject(obj:Object):coldfusion.air:SessionToken

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Saves or updates in the local database a data instance returned by the server CFC fetch method. This is an alternative to SaveUpdateCache function that you can use if the fetch method returns a single result. This function differs from SaveUpdate function. The SaveUpdate function inserts a new record or updates an existing one, whereas this method copies the object from server to the local database.

Parameters

obj:Object — Object that is passed to the function.

Returns

coldfusion.air:SessionToken — The session token associated with the call.

update

()

method

public function update(obj:Object):coldfusion.air:SessionToken

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

Updates the instance passed to it in the database. Corresponds to a SQL UPDATE operation.

Parameters

obj:Object — The object to update in the local database.

Returns

coldfusion.air:SessionToken — The session token associated with the call.

willTrigger

()

method

public function willTrigger(type:String):Boolean

Language Version:

ActionScript 3.0

Product Version:

CF 9

Runtime Versions:

Flash Player 9, AIR 1.0

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.

Adobe® ColdFusion® 9 Language Reference Language Reference only	All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Conventions \| Frames No Frames
Session	Properties \| Methods

Package	coldfusion.air
Class	public class Session
Inheritance	Session Object
Implements	IEventDispatcher