Java API:Transaction Management
From LongJump Support Wiki
The Transaction Management Java APIs provide the ability to Rollback transactions to a SavePoint.
- Transactions are operations on a record (such as Add, Update or Delete), and include modifying the contents of field data in a record
- Rollbacks perform an undo operation, reversing transactions to a previous SavePoint
- SavePoints are intermediate placemarks, which identify points at which the data fields contain intact, legitimate values
- When are SavePoints and Rollbacks used?
- A SavePoint might be set to identify the initial values of fields in a record, prior to applying a Transaction. Multiple SavePoints are typically used, whenever it might be important to track the values of fields in a record. SavePoints can be used to "undo" any transaction, or perform multiple "undos" to a specific "saved" condition.
- A Rollback might be performed when a series of actions cause an error condition, so it is necessary to return to previous SavePoint(s)
addSavePoint
- Functions.addSavePoint(String name)
- Adds a SavePoint with the string name.
- Syntax
Functions.addSavePoint(String name)
- Return
- None
- Example
- This example creates a SavePoint with the name Foo
Functions.addSavePoint("Foo");
For additional examples, see Rollback
rollbackToSavePoint
- Functions.rollbackToSavePoint(String name)
- Rollback the transaction to the SavePoint with the string name.
- Syntax
void Functions.rollbackToSavePoint(String name)
- Return
- None
doesSavePointExist
- Functions.doesSavePointExist(String name)
- Checks whether SavePoint exists with the string name.
- Syntax
boolean Functions.doesSavePointExist(String name)
- Return
- TRUE if the SavePoint with the string name exists, else returns FALSE
rollback
- Functions.rollback(String name)
- Performs a rollback of the entire transaction
- Syntax
void Functions.rollback()
- Return
- None
Examples
Single SavePoint Rollback
Rollback a record to the values contained in the last SavePoint
Functions.addSavePoint("save_point"); Parameters params = Functions.getParametersInstance(); params.add("first_name","Jack"); params.add("last_name","Nicholson"); Result result = Functions.addRecord("CONTACT",params); Functions.rollbackToSavePoint("save_point");
Multiple SavePoints Rollback
Restores multiple SavePoints to the initial state, and rolls back all of the addRecord actions.
Functions.addSavePoint("save_point"); Parameters params = Functions.getParametersInstance(); params.add("first_name","Jack"); params.add("last_name","Nicholson"); Result result = Functions.addRecord("CONTACT",params); Functions.addSavePoint("second_save_point"); Functions.debug("Second Save Point :"+Functions.doesSavePointExist("second_save_point")); Parameters secondParams = Functions.getParametersInstance(); secondParams.add("first_name","Anthony"); secondParams.add("last_name","Hopkins"); Result secondResult = Functions.addRecord("CONTACT",secondParams); Functions.addSavePoint("third_save_point"); Parameters thirdParams = Functions.getParametersInstance(); thirdParams.add("first_name","Clint"); thirdParams.add("last_name","Eastwood"); Result thirdResult = Functions.addRecord("CONTACT",thirdParams); Functions.rollbackToSavePoint("save_point");
Rollback Entire Transaction
Roll back a series of transactions, to the original SavePoint.
- From the web browser these results are seen:
- If a record was added before this transaction, then the record will not exist
- If a record was edited before this transaction, then no updates will be recorded for the record
Functions.addSavePoint("save_point"); Parameters params = Functions.getParametersInstance(); params.add("first_name","Jack"); params.add("last_name","Nicholson"); Result result = Functions.addRecord("CONTACT",params); Functions.addSavePoint("second_save_point"); Functions.debug("Second Save Point :"+doesSavePointExists("second_save_point")); Parameters secondParams = Functions.getParametersInstance(); secondParams.add("first_name","Anthony"); secondParams.add("last_name","Hopkins"); Result secondResult = Functions.addRecord("CONTACT",secondParams); Functions.rollback(); // rollbacks all batabase operations like insert, update and delete before this. Functions.addSavePoint("third_save_point"); Parameters thirdParams = Functions.getParametersInstance(); thirdParams.add("first_name","Client"); thirdParams.add("last_name","Eastwood"); Result thirdResult = Functions.addRecord("CONTACT",thirdParams);
removeSavePoint
- Functions.removeSavePoint(String name)
- Removes the specified SavePoint from a list of SavePoints.
- Syntax
void Functions.removeSavePoint(String name)
- Return
- None
showMessage
- Functions.showMessage(String key [, String[] args])
- Description
-
- Displays the message in the UI, irrespective of any database insertions or updates (without interrupting the program flow)
- Translates the token and displays the Custom Label in the selected language
Element Display Type Description key string Created from category name, followed by '.' and token name
- Syntax
#categoryname.tokenname
args string Optional Declares an array of Strings in Java (or Arguments)
- If arguments are passed, the call expects a token
- If no arguments are passed, the message alone is displayed
- Syntax
void Functions.showMessage(String key [, String[] args]);
If no arguments are needed (for example, for a label in the #custom category), use:
Functions.showMessage("#custom.label",null)
- Return
-
- Returns the localized message configured on the key in the Translation Workbench
- If no key is configured in the translation workbench, then the passed key is returned
getAllSavePoints
- getAllSavePoints()
- Returns Set of all Save Points.
- Syntax
set getAllSavePoints()
- Return
- Set of all SavePoints