Author: arminw
Date: Thu Jan 4 18:46:37 2007
New Revision: 492874
URL: http://svn.apache.org/viewvc?view=rev&rev=492874
Log:
update javadoc
Modified:
db/ojb/branches/OJB_1_0_RELEASE/src/java/org/apache/ojb/broker/PersistenceBroker.java
Modified:
db/ojb/branches/OJB_1_0_RELEASE/src/java/org/apache/ojb/broker/PersistenceBroker.java
URL:
http://svn.apache.org/viewvc/db/ojb/branches/OJB_1_0_RELEASE/src/java/org/apache/ojb/broker/PersistenceBroker.java?view=diff&rev=492874&r1=492873&r2=492874
==============================================================================
---
db/ojb/branches/OJB_1_0_RELEASE/src/java/org/apache/ojb/broker/PersistenceBroker.java
(original)
+++
db/ojb/branches/OJB_1_0_RELEASE/src/java/org/apache/ojb/broker/PersistenceBroker.java
Thu Jan 4 18:46:37 2007
@@ -35,14 +35,9 @@
import java.util.Iterator;
/**
- *
* PersistenceBroker declares a protocol for persisting arbitrary objects.
* A typical implementation might wrap an RDBMS access layer.
*
- * @see org.apache.ojb.broker.core.PersistenceBrokerImpl
- * @see org.apache.ojb.broker.core.PersistenceBrokerBean
- *
- * @author Thomas Mahler
* @version $Id$
*/
public interface PersistenceBroker extends Configurable, ObjectContainer
@@ -454,14 +449,30 @@
public Iterator getReportQueryIteratorByQuery(Query query) throws
PersistenceBrokerException;
/**
- * Retrieve a persistent object from the underlying datastore by its
identity. However, users
- * are encouraged to use [EMAIL PROTECTED] #getObjectByQuery(Query)}
instead, as this method is mainly
- * intended to be used for internal handling of materialization by OID
(e.g. in Proxies).
- *
- * @param id The persistent object's id
- * @return The persistent object
- */
- public Object getObjectByIdentity(Identity id) throws
PersistenceBrokerException;
+ * Retrieve a persistent object from the underlying datastore by its
identity. It's also possible
+ * to use [EMAIL PROTECTED] #getObjectByQuery(Query)} instead (in the past
this method is intended to be used
+ * for internal handling of materialization by OID - e.g. in Proxies,
however it's straightforward
+ * to materialize objects by its identity without creating a query object).
+ *
+ * @param oid The persistent object's oid.
+ * @return The persistent object.
+ */
+ public Object getObjectByIdentity(Identity oid) throws
PersistenceBrokerException;
+
+// TODO: Implement this method
+// /**
+// * Retrieve a persistent object from the underlying datastore by its
identity. It's also possible
+// * to use [EMAIL PROTECTED] #getObjectByQuery(Query)} instead (in the
past this method is intended to be used
+// * for internal handling of materialization by OID - e.g. in Proxies,
however it's straightforward
+// * to materialize objects by its identity without creating a query
object).
+// *
+// * @param oid The persistent object's oid.
+// * @param selectForUpdate If <em>true</em> a "SELECT ... FOR UPDATE"
against the database is performed
+// * in any case. If <em>false</em> first a cache lookup will be performed
and if no success a normal
+// * SELECT-clause is executed.
+// * @return The persistent object.
+// */
+// public Object getObjectByIdentity(Identity oid, boolean selectForUpdate)
throws PersistenceBrokerException;
/**
* Retrieve the (first) persistent object from the underlying datastore
that matches the given
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
