javax.jdo.spi
Interface StateInterrogation


public interface StateInterrogation

This interface is implemented by a non-binary-compatible JDO implementation to provide state interrogation for non-enhanced persistent classes. An instance that implements this interface is registered with the JDOImplHelper.

Since:
2.0
Version:
2.0

Method Summary
 java.lang.Object getObjectId(java.lang.Object pc)
          Return a copy of the JDO identity associated with the parameter instance.
 PersistenceManager getPersistenceManager(java.lang.Object pc)
          Return the associated PersistenceManager if there is one.
 java.lang.Object getTransactionalObjectId(java.lang.Object pc)
          Return a copy of the JDO identity associated with the parameter instance.
 java.lang.Boolean isDeleted(java.lang.Object pc)
          Tests whether the parameter instance has been deleted.
 java.lang.Boolean isDirty(java.lang.Object pc)
          Tests whether the parameter instance is dirty.
 java.lang.Boolean isNew(java.lang.Object pc)
          Tests whether the parameter instance has been newly made persistent.
 java.lang.Boolean isPersistent(java.lang.Object pc)
          Tests whether the parameter instance is persistent.
 java.lang.Boolean isTransactional(java.lang.Object pc)
          Tests whether the parameter instance is transactional.
 boolean makeDirty(java.lang.Object pc, java.lang.String fieldName)
          Explicitly mark the parameter instance and field dirty.
 

Method Detail

isPersistent

public java.lang.Boolean isPersistent(java.lang.Object pc)
Tests whether the parameter instance is persistent. Instances that represent persistent objects in the data store return true.

Transient instances and instances of classes that do not implement PersistenceCapable return false.

Parameters:
pc - the PersistenceCapable instance.
Returns:
true if the parameter instance is persistent.
See Also:
PersistenceManager.makePersistent(Object pc), PersistenceCapable.jdoIsPersistent()

isTransactional

public java.lang.Boolean isTransactional(java.lang.Object pc)
Tests whether the parameter instance is transactional. Instances whose state is associated with the current transaction return true.

Transient instances and instances of classes that do not implement PersistenceCapable return false.

Parameters:
pc - the PersistenceCapable instance.
Returns:
true if the parameter instance is transactional.
See Also:
PersistenceCapable.jdoIsTransactional()

isDirty

public java.lang.Boolean isDirty(java.lang.Object pc)
Tests whether the parameter instance is dirty. Instances that have been modified, deleted, or newly made persistent in the current transaction return true.

Transient instances and instances of classes that do not implement PersistenceCapable return false.

Parameters:
pc - the PersistenceCapable instance.
Returns:
true if the parameter instance has been modified in the current transaction.
See Also:
StateManager.makeDirty(PersistenceCapable pc, String fieldName), PersistenceCapable.jdoIsDirty()

isNew

public java.lang.Boolean isNew(java.lang.Object pc)
Tests whether the parameter instance has been newly made persistent. Instances that have been made persistent in the current transaction return true.

Transient instances and instances of classes that do not implement PersistenceCapable return false.

Parameters:
pc - the PersistenceCapable instance.
Returns:
true if the parameter instance was made persistent in the current transaction.
See Also:
PersistenceManager.makePersistent(Object pc), PersistenceCapable.jdoIsNew()

isDeleted

public java.lang.Boolean isDeleted(java.lang.Object pc)
Tests whether the parameter instance has been deleted. Instances that have been deleted in the current transaction return true.

Transient instances and instances of classes that do not implement PersistenceCapable return false.

Parameters:
pc - the PersistenceCapable instance.
Returns:
true if the parameter instance was deleted in the current transaction.
See Also:
PersistenceManager.deletePersistent(Object pc), PersistenceCapable.jdoIsDeleted()

getPersistenceManager

public PersistenceManager getPersistenceManager(java.lang.Object pc)
Return the associated PersistenceManager if there is one. Transactional and persistent instances return the associated PersistenceManager.

Transient non-transactional instances and instances of classes that do not implement PersistenceCapable return null.

Parameters:
pc - the PersistenceCapable instance.
Returns:
the PersistenceManager associated with the parameter instance.
See Also:
PersistenceCapable.jdoGetPersistenceManager()

getObjectId

public java.lang.Object getObjectId(java.lang.Object pc)
Return a copy of the JDO identity associated with the parameter instance.

Persistent instances of PersistenceCapable classes have a JDO identity managed by the PersistenceManager. This method returns a copy of the ObjectId that represents the JDO identity.

Transient instances and instances of classes that do not implement PersistenceCapable return null.

The ObjectId may be serialized and later restored, and used with a PersistenceManager from the same JDO implementation to locate a persistent instance with the same data store identity.

If the JDO identity is managed by the application, then the ObjectId may be used with a PersistenceManager from any JDO implementation that supports the PersistenceCapable class.

If the JDO identity is not managed by the application or the data store, then the ObjectId returned is only valid within the current transaction.

Parameters:
pc - the PersistenceCapable instance.
Returns:
a copy of the ObjectId of the parameter instance as of the beginning of the transaction.
See Also:
PersistenceManager.getObjectId(Object pc), PersistenceCapable.jdoGetObjectId(), PersistenceManager.getObjectById(Object oid, boolean validate)

getTransactionalObjectId

public java.lang.Object getTransactionalObjectId(java.lang.Object pc)
Return a copy of the JDO identity associated with the parameter instance.

Parameters:
pc - the PersistenceCapable instance.
Returns:
a copy of the ObjectId of the parameter instance as modified in this transaction.
See Also:
PersistenceCapable.jdoGetTransactionalObjectId(), PersistenceManager.getObjectById(Object oid, boolean validate)

makeDirty

public boolean makeDirty(java.lang.Object pc,
                         java.lang.String fieldName)
Explicitly mark the parameter instance and field dirty. Normally, PersistenceCapable classes are able to detect changes made to their fields. However, if a reference to an array is given to a method outside the class, and the array is modified, then the persistent instance is not aware of the change. This API allows the application to notify the instance that a change was made to a field.

Transient instances and instances of classes that do not implement PersistenceCapable ignore this method.

Parameters:
pc - the PersistenceCapable instance.
fieldName - the name of the field to be marked dirty.
See Also:
PersistenceCapable.jdoMakeDirty(String fieldName)