public interface ObjectContext extends Serializable
Modifier and Type | Method and Description |
---|---|
void |
commitChanges()
Flushes all changes to objects in this context to the parent DataChannel, cascading
flush operation all the way through the stack, ultimately saving data in the
database.
|
void |
commitChangesToParent()
Flushes all changes to objects in this context to the parent DataChannel.
|
ObjectContext |
createChildContext()
Deprecated.
Since 3.1 replaced by
CayenneRuntime.getContext(DataChannel) |
Collection<?> |
deletedObjects()
Returns a collection of objects that are registered with this ObjectContext and
have a state PersistenceState.DELETED
|
void |
deleteObject(Object object)
Schedules a persistent object for deletion on next commit.
|
void |
deleteObjects(Collection<?> objects)
Schedules deletion of a collection of persistent objects.
|
<T> void |
deleteObjects(T... objects)
Schedules deletion of one or more persistent objects.
|
DataChannel |
getChannel()
Returns an DataChannel used by this context.
|
EntityResolver |
getEntityResolver()
Returns EntityResolver that stores all mapping information accessible by this
ObjectContext.
|
GraphManager |
getGraphManager()
Returns GraphManager that manages object graph associated with this context.
|
Object |
getUserProperty(String key)
Returns a user-defined property previously set via 'setUserProperty'.
|
boolean |
hasChanges()
Returns
true if there are any modified, deleted or new objects
registered with this ObjectContext, false otherwise. |
void |
invalidateObjects(Collection<?> objects)
Invalidates a Collection of persistent objects.
|
<T> void |
invalidateObjects(T... objects)
Invalidates one or more persistent objects.
|
Persistent |
localObject(ObjectId id,
Object prototype)
Deprecated.
since 3.1 Cayenne users should use
localObject(Object) ; the
internal code has been refactored to avoid using this method all
together. |
<T> T |
localObject(T objectFromAnotherContext)
Returns a local copy of 'objectFromAnotherContext' object.
|
Collection<?> |
modifiedObjects()
Returns a collection of objects that are registered with this ObjectContext and
have a state PersistenceState.MODIFIED
|
<T> T |
newObject(Class<T> persistentClass)
Creates a new persistent object of a given class scheduled to be inserted to the
database on next commit.
|
Collection<?> |
newObjects()
Returns a collection of objects that are registered with this ObjectContext and
have a state PersistenceState.NEW
|
QueryResponse |
performGenericQuery(Query query)
Executes any kind of query providing the result in a form of QueryResponse.
|
List |
performQuery(Query query)
Executes a selecting query, returning a list of persistent objects or data rows.
|
void |
prepareForAccess(Persistent object,
String property,
boolean lazyFaulting)
A callback method that child Persistent objects are expected to call before
accessing property values.
|
void |
propertyChanged(Persistent object,
String property,
Object oldValue,
Object newValue)
A callback method that child Persistent objects are expected to call from inside
the setter after modifying a value of a persistent property, including "simple" and
"arc" properties.
|
void |
registerNewObject(Object object)
Registers a transient object with the context.
|
void |
rollbackChanges()
Resets all uncommitted changes made to the objects in this ObjectContext, cascading
rollback operation all the way through the stack.
|
void |
rollbackChangesLocally()
Resets all uncommitted changes made to the objects in this ObjectContext.
|
void |
setUserProperty(String key,
Object value)
Sets a user-defined property.
|
Collection<?> |
uncommittedObjects()
Returns a collection of MODIFIED, DELETED or NEW objects.
|
EntityResolver getEntityResolver()
Collection<?> newObjects()
Collection<?> deletedObjects()
Collection<?> modifiedObjects()
Collection<?> uncommittedObjects()
@Deprecated Persistent localObject(ObjectId id, Object prototype)
localObject(Object)
; the
internal code has been refactored to avoid using this method all
together.prototype
is not null, local object is refreshed with the prototype
values.
This method can do both "mapping" (i.e. finding an object with the same id in this context) and "synchronization" (i.e. updating the state of the found object with the state of the prototype object).
<T> T localObject(T objectFromAnotherContext)
Note that passing an object with a non-existing id, may later result in FaultFailureException on attempt to read returned object properties.
<T> T newObject(Class<T> persistentClass)
void registerNewObject(Object object)
newObject(Class)
is that a user creates an object herself, before
attaching it to the context, instead of relying on Cayenne to do that.object
- new object that needs to be made persistent.void deleteObject(Object object) throws DeleteDenyException
DeleteDenyException
- if a DeleteRule.DENY
delete rule is applicable for object deletion.void deleteObjects(Collection<?> objects) throws DeleteDenyException
DeleteDenyException
- if a DeleteRule.DENY
delete rule is applicable for object deletion.<T> void deleteObjects(T... objects) throws DeleteDenyException
deleteObjects(Collection)
only with a vararg argument list for easier
deletion of individual objects.DeleteDenyException
- if a DeleteRule.DENY
delete rule is applicable for object deletion.void prepareForAccess(Persistent object, String property, boolean lazyFaulting)
void propertyChanged(Persistent object, String property, Object oldValue, Object newValue)
void commitChanges()
void commitChangesToParent()
commitChanges()
, but no cascading flush occurs.void rollbackChanges()
void rollbackChangesLocally()
rollbackChanges()()
, but rollback is local to this context and no
cascading changes undoing occurs.List performQuery(Query query)
QueryResponse performGenericQuery(Query query)
GraphManager getGraphManager()
DataChannel getChannel()
@Deprecated ObjectContext createChildContext()
CayenneRuntime.getContext(DataChannel)
boolean hasChanges()
true
if there are any modified, deleted or new objects
registered with this ObjectContext, false
otherwise.void invalidateObjects(Collection<?> objects)
<T> void invalidateObjects(T... objects)
invalidateObjects(Collection)
only with a vararg argument list for easier
invalidation of individual objects. If no arguments are passed to this method, it
does nothing.Object getUserProperty(String key)
Copyright © 2001–2018 Apache Cayenne. All rights reserved.