KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > prevayler > Transaction


1 //Prevayler(TM) - The Free-Software Prevalence Layer.
2 //Copyright (C) 2001-2003 Klaus Wuestefeld
3 //This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
4
5 package org.prevayler;
6
7 import java.io.Serializable JavaDoc;
8 import java.util.Date JavaDoc;
9
10 /** An atomic Transaction to be executed on a Prevalent System. Any operation which changes the observable state of a prevalent system must be encapsulated as a Transaction. <br><br> IMPORTANT: Transactions CANNOT reference business objects directly. Instead, they must search the business objects they need given the Prevalent System. See org.prevayler.demos for usage examples. <br><br> Business objects referenced in a transaction will be mere copies of the original business objects when that transaction is recovered from the serialized transactionLog file. This will make the transactions work when they are executed for the first time but have no effect during shutdown recovery. This is known as the prevalence baptism problem because everyone comes across it, despite of this warning.
11  */
12 public interface Transaction extends Serializable JavaDoc {
13
14     /** This method is called by Prevayler.execute(Transaction) to execute this Transaction on the given Prevalent System. See org.prevayler.demos for usage examples.
15      * @param prevalentSystem The system on which this Transaction will execute.
16      * @param executionTime The time at which this Transaction is being executed. Every Transaction executes completely within a single moment in time. Logically, a Prevalent System's time does not pass during the execution of a Transaction.
17      */
18     public void executeOn(Object JavaDoc prevalentSystem, Date JavaDoc executionTime);
19
20 }
21
Popular Tags