.NET FAM_Session class - Appistry EAF v3.8

Class FAM_Session

Properties

string LockId	This property specifies the lock identifier. Only the get accessor is available for this property.
string Version	This property specifies the session version. Only the get accessor is available for this property.
int LeaseTimeout	This property specifies the maximum amount of time, in milliseconds, the data is locked. The get and set accessors are available for this property.

Methods

createFabricExternalSession

FAM_Session createFabricExternalSession(string lockId,
                                        string version)

This is the session factory constructor.

string	lock identifier
string	session version
Exceptions	NullReferenceException

Commit

void Commit( )

This method commits the data manipulation performed in the session.

Exceptions	FAM_Exception FAM_SpaceExecption FAM_InvalidSessionException FAM_InvalidInputException FAM_SessionLockException

Rollback

void Rollback( )

This method rolls back the data manipulations performed in the session and returns the data to the last commit point.
Note. The FAM does not keep past versions of the data. When data is locked, a copy is created. Once data has been committed, by sending the commit function or by the successful completion of a task, that copy is deleted. You can not go back to a previous version of data.

Exceptions	FAM_Exception FAM_SpaceExecption FAM_InvalidSessionException FAM_InvalidInputException FAM_SessionLockException

CommitPrep

void CommitPrep( )

This method is the first phase of a two-phase commit. To complete the commit you must send the commit method.

Exceptions	FAM_Exception FAM_SpaceExecption FAM_InvalidSessionException FAM_InvalidInputException FAM_SessionLockException

ToString

String ToString ( )

This method returns a descriptive string containing the space, key, timeout, maximum retries, and session data.

string	descriptive string