## Uses of Class
org.apache.torque.om.ObjectKey

- Packages that use ObjectKey
  Package | Description
  --- | ---
  org.apache.torque.manager | A manager/factory API for use with Torque-generated data beans.
  org.apache.torque.om | API for the classic Torque-generated object model.
  org.apache.torque.util | Misc. utility classes.

- - ### Uses of ObjectKey in org.apache.torque.manager

    Fields in org.apache.torque.manager with type parameters of type ObjectKey
    Modifier and Type | Field | Description
    --- | --- | ---
    `protected org.apache.commons.jcs.access.CacheAccess<ObjectKey<?>,​T>` | AbstractBaseManager.`cache` | used to cache the om objects. cache is set by the region property

    Methods in org.apache.torque.manager with parameters of type ObjectKey
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected T` | AbstractBaseManager.`cacheGet​(ObjectKey<?> key)` | Get an object from cache
    `protected T` | AbstractBaseManager.`getOMInstance​(ObjectKey<?> id)` | Return an instance of an om based on the id
    `protected T` | AbstractBaseManager.`getOMInstance​(ObjectKey<?> key, boolean fromCache)` | Return an instance of an om based on the id
    `protected List<T>` | AbstractBaseManager.`getOMs​(ObjectKey<?>... ids)` | Gets a list of om's based on id's.
    `protected T` | AbstractBaseManager.`putInstanceImpl​(ObjectKey<?> key, T om)` | Put an object into the cache
    `protected T` | AbstractBaseManager.`removeInstanceImpl​(ObjectKey<?> key)` | Remove an object from the cache
    `protected abstract T` | AbstractBaseManager.`retrieveStoredOM​(ObjectKey<?> id)` | Retrieve an object from persistent storage

    Method parameters in org.apache.torque.manager with type arguments of type ObjectKey
    Modifier and Type | Method | Description
    --- | --- | ---
    `protected List<T>` | AbstractBaseManager.`getOMs​(List<? extends ObjectKey<?>> ids)` | Gets a list of om's based on id's.
    `protected List<T>` | AbstractBaseManager.`getOMs​(List<? extends ObjectKey<?>> ids, boolean fromCache)` | Gets a list of om's based on id's.
    `protected abstract List<T>` | AbstractBaseManager.`retrieveStoredOMs​(List<? extends ObjectKey<?>> ids)` | Gets a list of om's based on id's.

  - ### Uses of ObjectKey in org.apache.torque.om

    Subclasses of ObjectKey in org.apache.torque.om
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `BooleanKey` | This class can be used as an ObjectKey to uniquely identify an object within an application where the id consists of a Boolean.
    `class` | `ComboKey` | This class can be used as an ObjectKey to uniquely identify an object within an application where the key consists of multiple entities (such a String[] representing a multi-column primary key).
    `class` | `DateKey` | This class can be used as an ObjectKey to uniquely identify an object within an application where the id is a Date.
    `class` | `NumberKey` | This class can be used as an ObjectKey to uniquely identify an object within an application where the id consists of a single entity such a GUID or the value of a db row's primary key.
    `class` | `SimpleKey<T>` | This empty class marks an ObjectKey as being capable of being represented as a single column in a database.
    `class` | `StringKey` | This class can be used as an ObjectKey to uniquely identify an object within an application where the id consists of a single entity such a GUID or the value of a db row's primary key.

    Methods in org.apache.torque.om with type parameters of type ObjectKey
    Modifier and Type | Method | Description
    --- | --- | ---
    `<O extends ObjectKey<T>> void` | ObjectKey.`setValue​(O key)` | Sets the internal representation to the same object used by key.

    Methods in org.apache.torque.om that return ObjectKey
    Modifier and Type | Method | Description
    --- | --- | ---
    `ObjectKey<?>` | ObjectModel.`getPrimaryKey()` | getter for the object primaryKey.

    Methods in org.apache.torque.om with parameters of type ObjectKey
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | ObjectModel.`setPrimaryKey​(ObjectKey<?> primaryKey)` | Sets the PrimaryKey for the object.

  - ### Uses of ObjectKey in org.apache.torque.util

    Methods in org.apache.torque.util that return ObjectKey
    Modifier and Type | Method | Description
    --- | --- | ---
    `ObjectKey<?>` | AbstractPeerImpl.`doInsert​(ColumnValues columnValues, Connection con)` | Method to do inserts.
    `ObjectKey<?>` | BasePeerImpl.`doInsert​(ColumnValues insertValues)` | Inserts a record into a database table.
    `ObjectKey<?>` | BasePeerImpl.`doInsert​(ColumnValues insertValues, Connection connection)` | Inserts a record into a database table.

    Methods in org.apache.torque.util with parameters of type ObjectKey
    Modifier and Type | Method | Description
    --- | --- | ---
    `Criteria` | AbstractPeerImpl.`buildCriteria​(ObjectKey<?> pk)` | Build a Criteria object which selects all objects which have a given primary key.
    `int` | AbstractPeerImpl.`doDelete​(ObjectKey<?> pk)` | Deletes a row in the database.
    `int` | AbstractPeerImpl.`doDelete​(ObjectKey<?> pk, Connection con)` | Deletes a row in the database.