Interface StateManager
PersistenceCapable
classes and the JDO implementation. It
contains the methods used by PersistenceCapable
instances to
delegate behavior to the JDO implementation.
Each managed PersistenceCapable
instance contains a reference
to a StateManager
. A StateManager
might manage one
or multiple instances of PersistenceCapable
instances, at the
choice of the implementation.
- Version:
- 2.0
-
Method Summary
Modifier and TypeMethodDescriptionboolean
getBooleanField
(PersistenceCapable pc, int field, boolean currentValue) Return the value for the field.byte
getByteField
(PersistenceCapable pc, int field, byte currentValue) Return the value for the field.char
getCharField
(PersistenceCapable pc, int field, char currentValue) Return the value for the field.double
getDoubleField
(PersistenceCapable pc, int field, double currentValue) Return the value for the field.float
getFloatField
(PersistenceCapable pc, int field, float currentValue) Return the value for the field.int
getIntField
(PersistenceCapable pc, int field, int currentValue) Return the value for the field.long
getLongField
(PersistenceCapable pc, int field, long currentValue) Return the value for the field.getObjectField
(PersistenceCapable pc, int field, Object currentValue) Return the value for the field.Return the object representing the JDO identity of the calling instance.Return thePersistenceManager
that owns this instance.short
getShortField
(PersistenceCapable pc, int field, short currentValue) Return the value for the field.getStringField
(PersistenceCapable pc, int field, String currentValue) Return the value for the field.Return the object representing the JDO identity of the calling instance.Return the object representing the version of the calling instance.boolean
Tests whether this object has been deleted.boolean
Tests whether this object is dirty.boolean
isLoaded
(PersistenceCapable pc, int field) Returntrue
if the field is cached in the calling instance.boolean
Tests whether this object has been newly made persistent.boolean
Tests whether this object is persistent.boolean
Tests whether this object is transactional.void
makeDirty
(PersistenceCapable pc, String fieldName) Mark the associatedPersistenceCapable
field dirty.void
Guarantee that the serializable transactional and persistent fields are loaded into the instance.void
providedBooleanField
(PersistenceCapable pc, int field, boolean currentValue) The value of the field requested to be provided to theStateManager
.void
providedByteField
(PersistenceCapable pc, int field, byte currentValue) The value of the field requested to be provided to theStateManager
.void
providedCharField
(PersistenceCapable pc, int field, char currentValue) The value of the field requested to be provided to theStateManager
.void
providedDoubleField
(PersistenceCapable pc, int field, double currentValue) The value of the field requested to be provided to theStateManager
.void
providedFloatField
(PersistenceCapable pc, int field, float currentValue) The value of the field requested to be provided to theStateManager
.void
providedIntField
(PersistenceCapable pc, int field, int currentValue) The value of the field requested to be provided to theStateManager
.void
providedLongField
(PersistenceCapable pc, int field, long currentValue) The value of the field requested to be provided to theStateManager
.void
providedObjectField
(PersistenceCapable pc, int field, Object currentValue) The value of the field requested to be provided to theStateManager
.void
providedShortField
(PersistenceCapable pc, int field, short currentValue) The value of the field requested to be provided to theStateManager
.void
providedStringField
(PersistenceCapable pc, int field, String currentValue) The value of the field requested to be provided to theStateManager
.boolean
replacingBooleanField
(PersistenceCapable pc, int field) The replacement value of the field in the calling instance.byte
replacingByteField
(PersistenceCapable pc, int field) The replacement value of the field in the calling instance.char
replacingCharField
(PersistenceCapable pc, int field) The replacement value of the field in the calling instance.Object[]
replacingDetachedState
(Detachable pc, Object[] state) The replacement value of the detached state in the calling instance.double
replacingDoubleField
(PersistenceCapable pc, int field) The replacement value of the field in the calling instance.byte
The owningStateManager
uses this method to supply the value of the flags to thePersistenceCapable
instance.float
replacingFloatField
(PersistenceCapable pc, int field) The replacement value of the field in the calling instance.int
replacingIntField
(PersistenceCapable pc, int field) The replacement value of the field in the calling instance.long
replacingLongField
(PersistenceCapable pc, int field) The replacement value of the field in the calling instance.replacingObjectField
(PersistenceCapable pc, int field) The replacement value of the field in the calling instance.short
replacingShortField
(PersistenceCapable pc, int field) The replacement value of the field in the calling instance.Replace the current value ofjdoStateManager
.replacingStringField
(PersistenceCapable pc, int field) The replacement value of the field in the calling instance.void
setBooleanField
(PersistenceCapable pc, int field, boolean currentValue, boolean newValue) Mark the field as modified by the user.void
setByteField
(PersistenceCapable pc, int field, byte currentValue, byte newValue) Mark the field as modified by the user.void
setCharField
(PersistenceCapable pc, int field, char currentValue, char newValue) Mark the field as modified by the user.void
setDoubleField
(PersistenceCapable pc, int field, double currentValue, double newValue) Mark the field as modified by the user.void
setFloatField
(PersistenceCapable pc, int field, float currentValue, float newValue) Mark the field as modified by the user.void
setIntField
(PersistenceCapable pc, int field, int currentValue, int newValue) Mark the field as modified by the user.void
setLongField
(PersistenceCapable pc, int field, long currentValue, long newValue) Mark the field as modified by the user.void
setObjectField
(PersistenceCapable pc, int field, Object currentValue, Object newValue) Mark the field as modified by the user.void
setShortField
(PersistenceCapable pc, int field, short currentValue, short newValue) Mark the field as modified by the user.void
setStringField
(PersistenceCapable pc, int field, String currentValue, String newValue) Mark the field as modified by the user.
-
Method Details
-
replacingFlags
The owningStateManager
uses this method to supply the value of the flags to thePersistenceCapable
instance.- Parameters:
pc
- the callingPersistenceCapable
instance- Returns:
- the value of
jdoFlags
to be stored in thePersistenceCapable
instance
-
replacingStateManager
Replace the current value ofjdoStateManager
.This method is called by the
PersistenceCapable
wheneverjdoReplaceStateManager
is called and there is already an owningStateManager
. This is a security precaution to ensure that the owningStateManager
is the only source of any change to its reference in thePersistenceCapable
.- Parameters:
pc
- the callingPersistenceCapable
instancesm
- the proposed new value for thejdoStateManager
- Returns:
- the new value for the
jdoStateManager
-
isDirty
Tests whether this object is dirty. Instances that have been modified, deleted, or newly made persistent in the current transaction returntrue
.Transient nontransactional instances return
false
.- Parameters:
pc
- the callingPersistenceCapable
instance- Returns:
true
if this instance has been modified in the current transaction.- See Also:
-
isTransactional
Tests whether this object is transactional. Instances that respect transaction boundaries returntrue
. These instances include transient instances made transactional as a result of being the target of amakeTransactional
method call; newly made persistent or deleted persistent instances; persistent instances read in data store transactions; and persistent instances modified in optimistic transactions.Transient nontransactional instances return
false
.- Parameters:
pc
- the callingPersistenceCapable
instance- Returns:
true
if this instance is transactional.
-
isPersistent
Tests whether this object is persistent. Instances whose state is stored in the data store returntrue
.Transient instances return
false
.- Parameters:
pc
- the callingPersistenceCapable
instance- Returns:
true
if this instance is persistent.- See Also:
-
isNew
Tests whether this object has been newly made persistent. Instances that have been made persistent in the current transaction returntrue
.Transient instances return
false
.- Parameters:
pc
- the callingPersistenceCapable
instance- Returns:
true
if this instance was made persistent in the current transaction.- See Also:
-
isDeleted
Tests whether this object has been deleted. Instances that have been deleted in the current transaction returntrue
.Transient instances return
false
.- Parameters:
pc
- the callingPersistenceCapable
instance- Returns:
true
if this instance was deleted in the current transaction.- See Also:
-
getPersistenceManager
Return thePersistenceManager
that owns this instance.- Parameters:
pc
- the callingPersistenceCapable
instance- Returns:
- the
PersistenceManager
that owns this instance
-
makeDirty
Mark the associatedPersistenceCapable
field dirty.The
StateManager
will make a copy of the field so it can be restored if needed later, and then mark the field as modified in the current transaction.- Parameters:
pc
- the callingPersistenceCapable
instancefieldName
- the name of the field
-
getObjectId
Return the object representing the JDO identity of the calling instance. If the JDO identity is being changed in the current transaction, this method returns the identity as of the beginning of the transaction.- Parameters:
pc
- the callingPersistenceCapable
instance- Returns:
- the object representing the JDO identity of the calling instance
-
getTransactionalObjectId
Return the object representing the JDO identity of the calling instance. If the JDO identity is being changed in the current transaction, this method returns the current identity as changed in the transaction.- Parameters:
pc
- the callingPersistenceCapable
instance- Returns:
- the object representing the JDO identity of the calling instance
-
getVersion
Return the object representing the version of the calling instance.- Parameters:
pc
- the callingPersistenceCapable
instance- Returns:
- the object representing the version of the calling instance
- Since:
- 2.0
-
isLoaded
Returntrue
if the field is cached in the calling instance.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field number- Returns:
- whether the field is cached in the calling instance
-
preSerialize
Guarantee that the serializable transactional and persistent fields are loaded into the instance. This method is called by the generatedjdoPreSerialize
method prior to serialization of the instance.- Parameters:
pc
- the callingPersistenceCapable
instance
-
getBooleanField
Return the value for the field.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the field- Returns:
- the new value for the field
-
getCharField
Return the value for the field.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the field- Returns:
- the new value for the field
-
getByteField
Return the value for the field.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the field- Returns:
- the new value for the field
-
getShortField
Return the value for the field.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the field- Returns:
- the new value for the field
-
getIntField
Return the value for the field.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the field- Returns:
- the new value for the field
-
getLongField
Return the value for the field.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the field- Returns:
- the new value for the field
-
getFloatField
Return the value for the field.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the field- Returns:
- the new value for the field
-
getDoubleField
Return the value for the field.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the field- Returns:
- the new value for the field
-
getStringField
Return the value for the field.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the field- Returns:
- the new value for the field
-
getObjectField
Return the value for the field.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the field- Returns:
- the new value for the field
-
setBooleanField
Mark the field as modified by the user.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the fieldnewValue
- the proposed new value of the field
-
setCharField
Mark the field as modified by the user.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the fieldnewValue
- the proposed new value of the field
-
setByteField
Mark the field as modified by the user.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the fieldnewValue
- the proposed new value of the field
-
setShortField
Mark the field as modified by the user.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the fieldnewValue
- the proposed new value of the field
-
setIntField
Mark the field as modified by the user.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the fieldnewValue
- the proposed new value of the field
-
setLongField
Mark the field as modified by the user.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the fieldnewValue
- the proposed new value of the field
-
setFloatField
Mark the field as modified by the user.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the fieldnewValue
- the proposed new value of the field
-
setDoubleField
Mark the field as modified by the user.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the fieldnewValue
- the proposed new value of the field
-
setStringField
Mark the field as modified by the user.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the fieldnewValue
- the proposed new value of the field
-
setObjectField
Mark the field as modified by the user.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the fieldnewValue
- the proposed new value of the field
-
providedBooleanField
The value of the field requested to be provided to theStateManager
.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the field
-
providedCharField
The value of the field requested to be provided to theStateManager
.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the field
-
providedByteField
The value of the field requested to be provided to theStateManager
.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the field
-
providedShortField
The value of the field requested to be provided to theStateManager
.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the field
-
providedIntField
The value of the field requested to be provided to theStateManager
.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the field
-
providedLongField
The value of the field requested to be provided to theStateManager
.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the field
-
providedFloatField
The value of the field requested to be provided to theStateManager
.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the field
-
providedDoubleField
The value of the field requested to be provided to theStateManager
.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the field
-
providedStringField
The value of the field requested to be provided to theStateManager
.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the field
-
providedObjectField
The value of the field requested to be provided to theStateManager
.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field numbercurrentValue
- the current value of the field
-
replacingBooleanField
The replacement value of the field in the calling instance.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field number- Returns:
- the new value for the field
-
replacingCharField
The replacement value of the field in the calling instance.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field number- Returns:
- the new value for the field
-
replacingByteField
The replacement value of the field in the calling instance.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field number- Returns:
- the new value for the field
-
replacingShortField
The replacement value of the field in the calling instance.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field number- Returns:
- the new value for the field
-
replacingIntField
The replacement value of the field in the calling instance.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field number- Returns:
- the new value for the field
-
replacingLongField
The replacement value of the field in the calling instance.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field number- Returns:
- the new value for the field
-
replacingFloatField
The replacement value of the field in the calling instance.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field number- Returns:
- the new value for the field
-
replacingDoubleField
The replacement value of the field in the calling instance.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field number- Returns:
- the new value for the field
-
replacingStringField
The replacement value of the field in the calling instance.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field number- Returns:
- the new value for the field
-
replacingObjectField
The replacement value of the field in the calling instance.- Parameters:
pc
- the callingPersistenceCapable
instancefield
- the field number- Returns:
- the new value for the field
-
replacingDetachedState
The replacement value of the detached state in the calling instance.- Parameters:
pc
- the callingDetachable
instancestate
- the current value of the detached state- Returns:
- the replacement value for the detached state
- Since:
- 2.0
-