## Uses of Interface
org.apache.cayenne.ObjectId

- Packages that use ObjectId
  Package | Description
  --- | ---
  org.apache.cayenne | Contains persistence APIs directly accessible by users.
  org.apache.cayenne.access | Contains classes that make up Cayenne ORM stack.
  org.apache.cayenne.access.event |
  org.apache.cayenne.access.flush |
  org.apache.cayenne.access.flush.operation |
  org.apache.cayenne.access.util |
  org.apache.cayenne.exp.property | Property API
  org.apache.cayenne.map | Contains O/R mapping classes that store relational database metadata information and map it to Java classes.
  org.apache.cayenne.query | Defines standard queries supported by Cayenne and extension mechanism to create custom queries.
  org.apache.cayenne.util | General utility classes.

- - ### Uses of ObjectId in org.apache.cayenne

    Fields in org.apache.cayenne declared as ObjectId
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected ObjectId` | PersistentObject.`objectId` |

    Methods in org.apache.cayenne that return ObjectId
    Modifier and Type | Method | Description
    --- | --- | ---
    `ObjectId` | ObjectId.`createReplacementId()` |
    `ObjectId` | DataRow.`createTargetObjectId​(String entityName, DbRelationship relationship)` | Returns an ObjectId of an object on the other side of the to-one relationship, for this DataRow representing a source of relationship.
    `ObjectId` | Persistent.`getObjectId()` |
    `ObjectId` | PersistentObject.`getObjectId()` |
    `static ObjectId` | ObjectId.`of​(String entityName)` | Creates a temporary ObjectId for a given entity.
    `static ObjectId` | ObjectId.`of​(String entityName, byte[] tmpKey)` | Creates a temporary ObjectId for a given entity, using provided unique id key.
    `static ObjectId` | ObjectId.`of​(String entityName, String keyName, Object value)` | Creates a single key/value permanent ObjectId.
    `static ObjectId` | ObjectId.`of​(String entityName, Map<String,​?> values)` | Creates an ObjectId, potentially mapped to multiple columns.
    `static ObjectId` | ObjectId.`of​(String entityName, ObjectId objectId)` | Creates an ObjectId using another id as a template, but for a different entity.

    Methods in org.apache.cayenne with parameters of type ObjectId
    Modifier and Type | Method | Description
    --- | --- | ---
    `static Object` | Cayenne.`objectForPK​(ObjectContext context, ObjectId id)` | Returns an object matching ObjectId.
    `static ObjectId` | ObjectId.`of​(String entityName, ObjectId objectId)` | Creates an ObjectId using another id as a template, but for a different entity.
    `void` | Persistent.`setObjectId​(ObjectId id)` |
    `void` | PersistentObject.`setObjectId​(ObjectId objectId)` |

  - ### Uses of ObjectId in org.apache.cayenne.access

    Fields in org.apache.cayenne.access declared as ObjectId
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected ObjectId` | OptimisticLockException.`failedObjectId` |

    Fields in org.apache.cayenne.access with type parameters of type ObjectId
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected ConcurrentMap<ObjectId,​DataRow>` | DataRowStore.`snapshots` |
    `protected Map<Object,​Map<String,​ObjectId>>` | ObjectStore.`trackedFlattenedPaths` | Map that tracks flattened paths for given object Id that is present in db.

    Methods in org.apache.cayenne.access that return ObjectId
    Modifier and Type | Method | Description
    --- | --- | ---
    `ObjectId` | ObjectDiff.`getArcSnapshotValue​(String propertyName)` |
    `ObjectId` | ObjectDiff.`getCurrentArcSnapshotValue​(String propertyName)` |
    `ObjectId` | OptimisticLockException.`getFailedObjectId()` | Returns the ObjectId of the object that caused the OptimisticLockException.
    `ObjectId` | ObjectStore.`getFlattenedId​(ObjectId objectId, String path)` |

    Methods in org.apache.cayenne.access that return types with arguments of type ObjectId
    Modifier and Type | Method | Description
    --- | --- | ---
    `Collection<ObjectId>` | ObjectStore.`getFlattenedIds​(ObjectId objectId)` |

    Methods in org.apache.cayenne.access with parameters of type ObjectId
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | DataRowStore.`forgetSnapshot​(ObjectId id)` | Evicts a snapshot from cache without generating any SnapshotEvents.
    `DataRow` | DataRowStore.`getCachedSnapshot​(ObjectId oid)` | Returns cached snapshot or null if no snapshot is currently cached for the given ObjectId.
    `DataRow` | ObjectStore.`getCachedSnapshot​(ObjectId oid)` | Returns a snapshot for ObjectId from the underlying snapshot cache.
    `ObjectId` | ObjectStore.`getFlattenedId​(ObjectId objectId, String path)` |
    `Collection<ObjectId>` | ObjectStore.`getFlattenedIds​(ObjectId objectId)` |
    `DataRow` | ObjectStore.`getSnapshot​(ObjectId oid)` | Returns a snapshot for ObjectId from the underlying snapshot cache.
    `void` | ObjectStore.`markFlattenedPath​(ObjectId objectId, String path, ObjectId id)` | Mark that flattened path for object has data row in DB.
    `default void` | OperationObserver.`nextGeneratedRows​(Query query, ResultIterator<?> keys, ObjectId idToUpdate)` | Deprecated. since 4.2, use `OperationObserver.nextGeneratedRows(Query, ResultIterator, List)`

    Method parameters in org.apache.cayenne.access with type arguments of type ObjectId
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | OperationObserver.`nextGeneratedRows​(Query query, ResultIterator<?> keys, List<ObjectId> idsToUpdate)` | Callback method invoked after each batch of generated values is read during an update.
    `void` | DataRowStore.`processSnapshotChanges​(Object postedBy, Map<ObjectId,​DataRow> updatedSnapshots, Collection<ObjectId> deletedSnapshotIds, Collection<ObjectId> invalidatedSnapshotIds, Collection<ObjectId> indirectlyModifiedIds)` | Processes changes made to snapshots.
    `void` | DataRowStore.`processSnapshotChanges​(Object postedBy, Map<ObjectId,​DataRow> updatedSnapshots, Collection<ObjectId> deletedSnapshotIds, Collection<ObjectId> invalidatedSnapshotIds, Collection<ObjectId> indirectlyModifiedIds)` | Processes changes made to snapshots.

    Constructors in org.apache.cayenne.access with parameters of type ObjectId
    Constructor | Description
    --- | ---
    `OptimisticLockException​(ObjectId id, DbEntity rootEntity, String querySQL, Map qualifierSnapshot)` |

  - ### Uses of ObjectId in org.apache.cayenne.access.event

    Fields in org.apache.cayenne.access.event with type parameters of type ObjectId
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected Collection<ObjectId>` | SnapshotEvent.`deletedIds` |
    `protected Collection<ObjectId>` | SnapshotEvent.`indirectlyModifiedIds` |
    `protected Collection<ObjectId>` | SnapshotEvent.`invalidatedIds` |
    `protected Map<ObjectId,​DataRow>` | SnapshotEvent.`modifiedDiffs` |

    Methods in org.apache.cayenne.access.event that return types with arguments of type ObjectId
    Modifier and Type | Method | Description
    --- | --- | ---
    `Collection<ObjectId>` | SnapshotEvent.`getDeletedIds()` |
    `Collection<ObjectId>` | SnapshotEvent.`getIndirectlyModifiedIds()` |
    `Collection<ObjectId>` | SnapshotEvent.`getInvalidatedIds()` |
    `Map<ObjectId,​DataRow>` | SnapshotEvent.`getModifiedDiffs()` |

    Constructor parameters in org.apache.cayenne.access.event with type arguments of type ObjectId
    Constructor | Description
    --- | ---
    `SnapshotEvent​(Object source, Object postedBy, Map<ObjectId,​DataRow> modifiedDiffs, Collection<ObjectId> deletedIds, Collection<ObjectId> invalidatedIds, Collection<ObjectId> indirectlyModifiedIds)` |
    `SnapshotEvent​(Object source, Object postedBy, Map<ObjectId,​DataRow> modifiedDiffs, Collection<ObjectId> deletedIds, Collection<ObjectId> invalidatedIds, Collection<ObjectId> indirectlyModifiedIds)` |

  - ### Uses of ObjectId in org.apache.cayenne.access.flush

    Constructors in org.apache.cayenne.access.flush with parameters of type ObjectId
    Constructor | Description
    --- | ---
    `EffectiveOpId​(String entityName, ObjectId id)` |
    `EffectiveOpId​(ObjectId id)` |

  - ### Uses of ObjectId in org.apache.cayenne.access.flush.operation

    Fields in org.apache.cayenne.access.flush.operation declared as ObjectId
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected ObjectId` | BaseDbRowOp.`changeId` |

    Fields in org.apache.cayenne.access.flush.operation with type parameters of type ObjectId
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected Map<String,​ObjectId>` | Values.`flattenedIds` |

    Methods in org.apache.cayenne.access.flush.operation that return ObjectId
    Modifier and Type | Method | Description
    --- | --- | ---
    `ObjectId` | BaseDbRowOp.`getChangeId()` |
    `ObjectId` | DbRowOp.`getChangeId()` |

    Methods in org.apache.cayenne.access.flush.operation that return types with arguments of type ObjectId
    Modifier and Type | Method | Description
    --- | --- | ---
    `Map<String,​ObjectId>` | Values.`getFlattenedIds()` |

    Methods in org.apache.cayenne.access.flush.operation with parameters of type ObjectId
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | Values.`addFlattenedId​(String path, ObjectId id)` |
    `void` | DeleteDbRowOp.`setChangeId​(ObjectId changeId)` |

    Constructors in org.apache.cayenne.access.flush.operation with parameters of type ObjectId
    Constructor | Description
    --- | ---
    `BaseDbRowOp​(Persistent object, DbEntity entity, ObjectId id)` |
    `DeleteDbRowOp​(Persistent object, DbEntity entity, ObjectId id)` |
    `InsertDbRowOp​(Persistent object, DbEntity entity, ObjectId id)` |
    `UpdateDbRowOp​(Persistent object, DbEntity entity, ObjectId id)` |

  - ### Uses of ObjectId in org.apache.cayenne.access.util

    Method parameters in org.apache.cayenne.access.util with type arguments of type ObjectId
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | DefaultOperationObserver.`nextGeneratedRows​(Query query, ResultIterator<?> keys, List<ObjectId> idsToUpdate)` | Closes ResultIterator without reading its data.
    `void` | DoNothingOperationObserver.`nextGeneratedRows​(Query query, ResultIterator<?> keys, List<ObjectId> idsToUpdate)` |

  - ### Uses of ObjectId in org.apache.cayenne.exp.property

    Methods in org.apache.cayenne.exp.property with parameters of type ObjectId
    Modifier and Type | Method | Description
    --- | --- | ---
    `default Expression` | IdProperty.`eq​(ObjectId value)` |

  - ### Uses of ObjectId in org.apache.cayenne.map

    Methods in org.apache.cayenne.map with parameters of type ObjectId
    Modifier and Type | Method | Description
    --- | --- | ---
    `boolean` | DbEntity.`isFullReplacementIdAttached​(ObjectId id)` | Returns true if there is full replacement id is attached to an ObjectId.

  - ### Uses of ObjectId in org.apache.cayenne.query

    Fields in org.apache.cayenne.query declared as ObjectId
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected ObjectId` | BatchQueryRow.`objectId` |
    `protected ObjectId` | ObjectIdQuery.`objectId` |
    `protected ObjectId` | RelationshipQuery.`objectId` |

    Methods in org.apache.cayenne.query that return ObjectId
    Modifier and Type | Method | Description
    --- | --- | ---
    `ObjectId` | BatchQueryRow.`getObjectId()` |
    `ObjectId` | ObjectIdQuery.`getObjectId()` |
    `ObjectId` | RelationshipQuery.`getObjectId()` |

    Methods in org.apache.cayenne.query with parameters of type ObjectId
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | InsertBatchQuery.`add​(Map<String,​Object> snapshot, ObjectId id)` | Adds a snapshot to batch.
    `void` | UpdateBatchQuery.`add​(Map<String,​Object> qualifierSnapshot, Map<String,​Object> updateSnapshot, ObjectId id)` | Adds a parameter row to the batch.
    `static SelectById<DataRow>` | SelectById.`dataRowQuery​(ObjectId id)` |
    `static SelectById<DataRow>` | SelectById.`dataRowQuery​(ObjectId firstId, ObjectId... otherIds)` |
    `static <T> SelectById<T>` | SelectById.`query​(Class<T> entityType, ObjectId id)` |
    `static <T> SelectById<T>` | SelectById.`query​(Class<T> entityType, ObjectId firstId, ObjectId... otherIds)` |

    Constructors in org.apache.cayenne.query with parameters of type ObjectId
    Constructor | Description
    --- | ---
    `BatchQueryRow​(ObjectId objectId, Map<String,​Object> qualifier)` |
    `MultiMapIdSpec​(ObjectId firstId, ObjectId... otherIds)` |
    `ObjectIdQuery​(ObjectId objectID)` | Creates a refreshing ObjectIdQuery.
    `ObjectIdQuery​(ObjectId objectId, boolean fetchingDataRows, int cachePolicy)` | Creates a new ObjectIdQuery.
    `RelationshipQuery​(ObjectId objectID, String relationshipName)` | Creates a RelationshipQuery.
    `RelationshipQuery​(ObjectId objectID, String relationshipName, boolean refreshing)` | Creates a RelationshipQuery.

  - ### Uses of ObjectId in org.apache.cayenne.util

    Fields in org.apache.cayenne.util with type parameters of type ObjectId
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected Map<ObjectId,​Persistent>` | ObjectDetachOperation.`seen` |

    Methods in org.apache.cayenne.util with parameters of type ObjectId
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected Object` | ObjectContextQueryAction.`polymorphicObjectFromCache​(ObjectId superOid)` |