# Package org.apache.cayenne

package org.apache.cayenne

Contains persistence APIs directly accessible by users.

- Class
  Description
  BaseContext
  Deprecated, for removal: This API element is subject to removal in a future version.
  use `DataContext` directly
  BaseDataObject
  Deprecated, for removal: This API element is subject to removal in a future version.
  use `PersistentObject` directly
  Cayenne
  Various utils for processing persistent objects and their properties
  CayenneRuntimeException
  A generic unchecked exception that may be thrown by Cayenne framework.
  CayenneSqlException
  An exception thrown when a failure occurs while executing a query statement or reading its results.
  ConfigurationException
  A runtime exception thrown on failures in Cayenne configuration.
  DataChannel
  DataChannel is an abstraction used by ObjectContexts to obtain mapping metadata and access a persistent store.
  DataChannelListener
  A listener of `DataChannel` lifecycle events.
  DataChannelQueryFilter
  An interface of a filter that allows to intercept DataChannel query operations.
  DataChannelQueryFilterChain
  Interface for chain of query filters
  DataChannelSyncCallbackAction
  DataChannelSyncFilter
  An interface of a filter that allows to intercept DataChannel sync operations.
  DataChannelSyncFilterChain
  Interface for chain of sync filters
  DataObject
  Deprecated, for removal: This API element is subject to removal in a future version.
  use `Persistent` interface directly
  DataRow
  DataRow a map that holds values retrieved from the database for a given query row.
  DeleteDenyException
  An exception thrown during an attempt to delete an object that has a relationship to a non-null related object, that has a DENY delete rule.
  EmbeddableObject
  ExtendedEnumeration
  An interface that Enum classes may implement to map enum instances to arbitrary DB values that do not match the enum names or positions.
  Fault
  Represents a placeholder for an unresolved relationship from a source object.
  FaultFailureException
  A runtime exception thrown when during lazy object initialization Cayenne finds that no matching row exists in the database for a given ObjectId.
  GenericPersistentObject
  Implementation of `Persistent` that uses `Map` to store object fields.
  HybridPersistentObject
  This data object like `GenericPersistentObject` uses `Map` to store generic attributes, only difference is that this Map will be created lazily at first write, thus reducing memory penalty if possible.
  LifecycleListener
  A callback interface to listen to persistent object lifecycle events.
  ObjectContext
  A Cayenne object facade to a persistent store.
  ObjectId
  A portable global identifier for persistent objects.
  PersistenceState
  Defines a set of object states from the point of view of persistence.
  Persistent
  Defines minimal API of an object that can be persisted via Cayenne.
  PersistentObject
  Base implementation of `Persistent`, have no assumption about how data is actually stored.
  ProcedureResult<T>
  Result of procedure call.
  QueryResponse
  Represents a result of query execution.
  QueryResult<T>
  Represents a collection of items which are results of a multipart query execution.
  QueryResultItem<T>
  Represents a single item in a multipart query execution.
  ResultBatchIterator<T>
  Defines API of a batch iterator over the ResultIterator returned as a result of Select queries execution.
  ResultIterator<T>
  Defines API of an iterator over the records returned as a result of selecting queries execution.
  ResultIteratorCallback<T>
  A callback interface invoked on each row when iterating over `ResultIterator`.
  Validating
  Defines a number of callback methods that allow an object to be validated before safe.
  ValueHolder<E>
  Provides a level of indirection for property value access, most often used for deferred faulting of to-one relationships.