# com.beasys.commerce.util
PersistenceHelper Class

public final class PersistenceHelper
extends `Object`

Persistence Helper provides an optional, cross-platform optimization for dependent objects in the persistence cache. BY DEFAULT THIS FEATURE IS TURNED OFF * This is not required for CMP or BMP.

Hierarchy
  `Object`
  `PersistenceHelper`

## Nested Class Summary

`public static class` | `PersistenceHelper.DefaultSmartCollectionReference`
`public static class` | `PersistenceHelper.DefaultSmartEntityReference`
`public static class` | `PersistenceHelper.DefaultSmartMapReference`

## Constructor Summary

PersistenceHelper()

## Method Summary

`public static `SmartEntityReference`` | `createDefaultSmartEntityReference`()
`public static `SmartEntityReference`` | `createDefaultSmartEntityReference`(`EJBObject` ejbObject)
`public static `SmartCollectionReference`` | `createSmartCollectionReference`(`String` attributeIdentifier, `SmartCollectionReference` targetInstance, `EntityImpl` entityImpl)
`public static `SmartCollectionReference`` | `createSmartCollectionReference`(`String` attributeIdentifier, `SmartCollectionReference` targetInstance, `SessionImpl` sessionImpl)
`public static `SmartCollectionReference`` | `createSmartCollectionReference`(`String` attributeIdentifier, `SmartCollectionReference` targetInstance, `BelongingImpl` belonging)
`public static `SmartEntityReference`` | `createSmartEntityReference`(`String` attributeIdentifier, `SmartEntityReference` targetInstance, `EntityImpl` entityImpl)
`public static `SmartEntityReference`` | `createSmartEntityReference`(`String` attributeIdentifier, `SmartEntityReference` targetInstance, `SessionImpl` sessionImpl)
`public static `SmartEntityReference`` | `createSmartEntityReference`(`String` attributeIdentifier, `SmartEntityReference` targetInstance, `BelongingImpl` belonging)
`public static `SmartMapReference`` | `createSmartMapReference`(`String` attributeIdentifier, `SmartMapReference` targetInstance, `EntityImpl` entityImpl) Allocate an instance of a smart map
`public static `SmartMapReference`` | `createSmartMapReference`(`String` attributeIdentifier, `SmartMapReference` targetInstance, `SessionImpl` sessionImpl) Allocate an instance of a smart map
`public static `SmartMapReference`` | `createSmartMapReference`(`String` attributeIdentifier, `SmartMapReference` targetInstance, `BelongingImpl` belonging)
`public static `Belonging`` | `doRelationalBinding`(`String` attributeIdentifier, `Belonging` value, `EntityImpl` entityImpl) Standardize an instance of an attribute type for a specific attribute on a bean.
`public static `Object`` | `doRelationalBinding`(`String` attributeIdentifier, `Object` value, `EntityImpl` entityImpl) Standardize an instance of an attribute type for a specific attribute on a bean.
`public static `EJBObject`` | `doRelationalBinding`(`String` attributeIdentifier, `EJBObject` ejbObject, `EntityImpl` entityImpl) Standardize an instance of an attribute type for a specific attribute on a bean.
`public static `Belonging`` | `doRelationalBinding`(`String` attributeIdentifier, `Belonging` value, `EJBObject` parent, `BelongingImpl` belongingImpl) Standardize an instance of an attribute type for a specific attribute on a bean.
`public static `Object`` | `doRelationalBinding`(`String` attributeIdentifier, `Object` value, `EJBObject` parent, `BelongingImpl` belongingImpl) Standardize an instance of an attribute type for a specific attribute on a bean.
`public static `EJBObject`` | `doRelationalBinding`(`String` attributeIdentifier, `EJBObject` ejbObject, `EJBObject` parent, `BelongingImpl` belongingImpl) Standardize an instance of an attribute type for a specific attribute on a bean.
`public static `Belonging`` | `doRelationalBindingWithMapKey`(`String` attributeIdentifier, `Belonging` value, `Object` mapKey, `EntityImpl` entityImpl) Standardize an instance of an attribute type for a specific attribute on a bean.
`public static `Object`` | `doRelationalBindingWithMapKey`(`String` attributeIdentifier, `Object` value, `Object` mapKey, `EntityImpl` entityImpl) Standardize an instance of an attribute type for a specific attribute on a bean.
`public static `EJBObject`` | `doRelationalBindingWithMapKey`(`String` attributeIdentifier, `EJBObject` ejbObject, `Object` mapKey, `EntityImpl` entityImpl) Standardize an instance of an attribute type for a specific attribute on a bean.
`public static `Belonging`` | `doRelationalBindingWithMapKey`(`String` attributeIdentifier, `Belonging` value, `Object` mapKey, `EJBObject` parent, `BelongingImpl` belongingImpl) Standardize an instance of an attribute type for a specific attribute on a bean.
`public static `Object`` | `doRelationalBindingWithMapKey`(`String` attributeIdentifier, `Object` value, `Object` mapKey, `EJBObject` parent, `BelongingImpl` belongingImpl) Standardize an instance of an attribute type for a specific attribute on a bean.
`public static `EJBObject`` | `doRelationalBindingWithMapKey`(`String` attributeIdentifier, `EJBObject` ejbObject, `Object` mapKey, `EJBObject` parent, `BelongingImpl` belongingImpl) Standardize an instance of an attribute type for a specific attribute on a bean.
`public static final `Belonging`` | `synchronizeWithCache`(`String` attributeIdentifier, `Belonging` value, `EntityImpl` entityImpl) Synchronize the dependent object with the persistence cache
`public static final `Object`` | `synchronizeWithCache`(`String` attributeIdentifier, `Object` value, `EntityImpl` entityImpl) Synchronize the dependent object with the persistence cache
`public static final `Collection`` | `synchronizeWithCache`(`String` attributeIdentifier, `Collection` collection, `EntityImpl` entityImpl) Synchronize the dependent object with the persistence cache
`public static final `Map`` | `synchronizeWithCache`(`String` attributeIdentifier, `Map` map, `EntityImpl` entityImpl) Synchronize the dependent object with the persistence cache
`public static final `Belonging`` | `synchronizeWithCache`(`Belonging` value, `EntityImpl` entityImpl) Synchronize the dependent object with the persistence cache
`public static final `Object`` | `synchronizeWithCache`(`Object` value, `EntityImpl` entityImpl) Synchronize the dependent object with the persistence cache

Methods from class `java.lang.`Object``
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

## Constructor Detail

### PersistenceHelper

    public PersistenceHelper()

## Method Detail

### createDefaultSmartEntityReference() Method

    public static SmartEntityReference createDefaultSmartEntityReference()

### createDefaultSmartEntityReference(EJBObject) Method

    public static SmartEntityReference createDefaultSmartEntityReference(EJBObject ejbObject)

### createSmartCollectionReference(String, SmartCollectionReference, EntityImpl) Method

    public static SmartCollectionReference createSmartCollectionReference(String attributeIdentifier,
                                                                          SmartCollectionReference targetInstance,
                                                                          EntityImpl entityImpl)

### createSmartCollectionReference(String, SmartCollectionReference, SessionImpl) Method

    public static SmartCollectionReference createSmartCollectionReference(String attributeIdentifier,
                                                                          SmartCollectionReference targetInstance,
                                                                          SessionImpl sessionImpl)

### createSmartCollectionReference(String, SmartCollectionReference, BelongingImpl) Method

    public static SmartCollectionReference createSmartCollectionReference(String attributeIdentifier,
                                                                          SmartCollectionReference targetInstance,
                                                                          BelongingImpl belonging)

### createSmartEntityReference(String, SmartEntityReference, EntityImpl) Method

    public static SmartEntityReference createSmartEntityReference(String attributeIdentifier,
                                                                  SmartEntityReference targetInstance,
                                                                  EntityImpl entityImpl)

### createSmartEntityReference(String, SmartEntityReference, SessionImpl) Method

    public static SmartEntityReference createSmartEntityReference(String attributeIdentifier,
                                                                  SmartEntityReference targetInstance,
                                                                  SessionImpl sessionImpl)

### createSmartEntityReference(String, SmartEntityReference, BelongingImpl) Method

    public static SmartEntityReference createSmartEntityReference(String attributeIdentifier,
                                                                  SmartEntityReference targetInstance,
                                                                  BelongingImpl belonging)

### createSmartMapReference(String, SmartMapReference, EntityImpl) Method

    public static SmartMapReference createSmartMapReference(String attributeIdentifier,
                                                            SmartMapReference targetInstance,
                                                            EntityImpl entityImpl)

Allocate an instance of a smart map

### createSmartMapReference(String, SmartMapReference, SessionImpl) Method

    public static SmartMapReference createSmartMapReference(String attributeIdentifier,
                                                            SmartMapReference targetInstance,
                                                            SessionImpl sessionImpl)

Allocate an instance of a smart map

### createSmartMapReference(String, SmartMapReference, BelongingImpl) Method

    public static SmartMapReference createSmartMapReference(String attributeIdentifier,
                                                            SmartMapReference targetInstance,
                                                            BelongingImpl belonging)

### doRelationalBinding(String, Belonging, EntityImpl) Method

    public static Belonging doRelationalBinding(String attributeIdentifier,
                                                Belonging value,
                                                EntityImpl entityImpl)

Standardize an instance of an attribute type for a specific attribute on a bean. Standardized instances may contain additional information suitable for mapping to a relational database. See BEA documentation for more information about this optional feature. BY DEFAULT THIS FEATURE IS TURNED OFF

#### Parameters

attributeIdentifier
  identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers

value
  instance of a belonging

entityImpl
  implementation of an entity bean

#### Returns

an instance of the input value, standardized for mapping to a relational database.

### doRelationalBinding(String, Object, EntityImpl) Method

    public static Object doRelationalBinding(String attributeIdentifier,
                                             Object value,
                                             EntityImpl entityImpl)

Standardize an instance of an attribute type for a specific attribute on a bean. Standardized instances may contain additional information suitable for mapping to a relational database. See BEA documentation for more information about this optional feature. BY DEFAULT THIS FEATURE IS TURNED OFF

#### Parameters

attributeIdentifier
  identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers

value
  instance of a belonging

entityImpl
  implementation of an entity bean

#### Returns

an instance of the input value, standardized for mapping to a relational database.

### doRelationalBinding(String, EJBObject, EntityImpl) Method

    public static EJBObject doRelationalBinding(String attributeIdentifier,
                                                EJBObject ejbObject,
                                                EntityImpl entityImpl)

Standardize an instance of an attribute type for a specific attribute on a bean. Standardized instances may contain additional information suitable for mapping to a relational database. See BEA documentation for more information about this optional feature. BY DEFAULT THIS FEATURE IS TURNED OFF

#### Parameters

attributeIdentifier
  identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers

ejbObject
  instance of a remote interface

entityImpl
  implementation of an entity bean

#### Returns

an instance of the input value, standardized for mapping to a relational database.

### doRelationalBinding(String, Belonging, EJBObject, BelongingImpl) Method

    public static Belonging doRelationalBinding(String attributeIdentifier,
                                                Belonging value,
                                                EJBObject parent,
                                                BelongingImpl belongingImpl)

Standardize an instance of an attribute type for a specific attribute on a bean. Standardized instances may contain additional information suitable for mapping to a relational database. See BEA documentation for more information about this optional feature. BY DEFAULT THIS FEATURE IS TURNED OFF

#### Parameters

attributeIdentifier
  identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers

value
  instance of a belonging

parent
  implementation of an entity bean

#### Returns

an instance of the input value, standardized for mapping to a relational database.

### doRelationalBinding(String, Object, EJBObject, BelongingImpl) Method

    public static Object doRelationalBinding(String attributeIdentifier,
                                             Object value,
                                             EJBObject parent,
                                             BelongingImpl belongingImpl)

Standardize an instance of an attribute type for a specific attribute on a bean. Standardized instances may contain additional information suitable for mapping to a relational database. See BEA documentation for more information about this optional feature. BY DEFAULT THIS FEATURE IS TURNED OFF

#### Parameters

attributeIdentifier
  identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers

value
  instance of a belonging

parent
  implementation of an entity bean

#### Returns

an instance of the input value, standardized for mapping to a relational database.

### doRelationalBinding(String, EJBObject, EJBObject, BelongingImpl) Method

    public static EJBObject doRelationalBinding(String attributeIdentifier,
                                                EJBObject ejbObject,
                                                EJBObject parent,
                                                BelongingImpl belongingImpl)

Standardize an instance of an attribute type for a specific attribute on a bean. Standardized instances may contain additional information suitable for mapping to a relational database. See BEA documentation for more information about this optional feature. BY DEFAULT THIS FEATURE IS TURNED OFF

#### Parameters

attributeIdentifier
  identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers

ejbObject
  instance of a remote interface

parent
  implementation of an entity bean

#### Returns

an instance of the input value, standardized for mapping to a relational database.

### doRelationalBindingWithMapKey(String, Belonging, Object, EntityImpl) Method

    public static Belonging doRelationalBindingWithMapKey(String attributeIdentifier,
                                                          Belonging value,
                                                          Object mapKey,
                                                          EntityImpl entityImpl)

Standardize an instance of an attribute type for a specific attribute on a bean. Standardized instances may contain additional information suitable for mapping to a relational database. See BEA documentation for more information about this optional feature. BY DEFAULT THIS FEATURE IS TURNED OFF

#### Parameters

attributeIdentifier
  identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers

value
  instance of a belonging

mapKey
  implementation of an entity bean

#### Returns

an instance of the input value, standardized for mapping to a relational database.

### doRelationalBindingWithMapKey(String, Object, Object, EntityImpl) Method

    public static Object doRelationalBindingWithMapKey(String attributeIdentifier,
                                                       Object value,
                                                       Object mapKey,
                                                       EntityImpl entityImpl)

Standardize an instance of an attribute type for a specific attribute on a bean. Standardized instances may contain additional information suitable for mapping to a relational database. See BEA documentation for more information about this optional feature. BY DEFAULT THIS FEATURE IS TURNED OFF

#### Parameters

attributeIdentifier
  identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers

value
  instance of a belonging

mapKey
  implementation of an entity bean

#### Returns

an instance of the input value, standardized for mapping to a relational database.

### doRelationalBindingWithMapKey(String, EJBObject, Object, EntityImpl) Method

    public static EJBObject doRelationalBindingWithMapKey(String attributeIdentifier,
                                                          EJBObject ejbObject,
                                                          Object mapKey,
                                                          EntityImpl entityImpl)

Standardize an instance of an attribute type for a specific attribute on a bean. Standardized instances may contain additional information suitable for mapping to a relational database. See BEA documentation for more information about this optional feature. BY DEFAULT THIS FEATURE IS TURNED OFF

#### Parameters

attributeIdentifier
  identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers

ejbObject
  instance of a remote interface

mapKey
  implementation of an entity bean

#### Returns

an instance of the input value, standardized for mapping to a relational database.

### doRelationalBindingWithMapKey(String, Belonging, Object, EJBObject, BelongingImpl) Method

    public static Belonging doRelationalBindingWithMapKey(String attributeIdentifier,
                                                          Belonging value,
                                                          Object mapKey,
                                                          EJBObject parent,
                                                          BelongingImpl belongingImpl)

Standardize an instance of an attribute type for a specific attribute on a bean. Standardized instances may contain additional information suitable for mapping to a relational database. See BEA documentation for more information about this optional feature. BY DEFAULT THIS FEATURE IS TURNED OFF

#### Parameters

attributeIdentifier
  identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers

value
  instance of a belonging

mapKey
  implementation of an entity bean

#### Returns

an instance of the input value, standardized for mapping to a relational database.

### doRelationalBindingWithMapKey(String, Object, Object, EJBObject, BelongingImpl) Method

    public static Object doRelationalBindingWithMapKey(String attributeIdentifier,
                                                       Object value,
                                                       Object mapKey,
                                                       EJBObject parent,
                                                       BelongingImpl belongingImpl)

Standardize an instance of an attribute type for a specific attribute on a bean. Standardized instances may contain additional information suitable for mapping to a relational database. See BEA documentation for more information about this optional feature. BY DEFAULT THIS FEATURE IS TURNED OFF

#### Parameters

attributeIdentifier
  identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers

value
  instance of a belonging

mapKey
  implementation of an entity bean

#### Returns

an instance of the input value, standardized for mapping to a relational database.

### doRelationalBindingWithMapKey(String, EJBObject, Object, EJBObject, BelongingImpl) Method

    public static EJBObject doRelationalBindingWithMapKey(String attributeIdentifier,
                                                          EJBObject ejbObject,
                                                          Object mapKey,
                                                          EJBObject parent,
                                                          BelongingImpl belongingImpl)

Standardize an instance of an attribute type for a specific attribute on a bean. Standardized instances may contain additional information suitable for mapping to a relational database. See BEA documentation for more information about this optional feature. BY DEFAULT THIS FEATURE IS TURNED OFF

#### Parameters

attributeIdentifier
  identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers

ejbObject
  instance of a remote interface

mapKey
  implementation of an entity bean

#### Returns

an instance of the input value, standardized for mapping to a relational database.

### synchronizeWithCache(String, Belonging, EntityImpl) Method

    public static final Belonging synchronizeWithCache(String attributeIdentifier,
                                                       Belonging value,
                                                       EntityImpl entityImpl)

Synchronize the dependent object with the persistence cache

#### Parameters

attributeIdentifier
  identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers

value
  instance of a belonging

entityImpl
  implementation of an entity bean

### synchronizeWithCache(String, Object, EntityImpl) Method

    public static final Object synchronizeWithCache(String attributeIdentifier,
                                                    Object value,
                                                    EntityImpl entityImpl)

Synchronize the dependent object with the persistence cache

#### Parameters

attributeIdentifier
  identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers * @param value instance of a belonging * @param entityImpl implementation of an entity bean

### synchronizeWithCache(String, Collection, EntityImpl) Method

    public static final Collection synchronizeWithCache(String attributeIdentifier,
                                                        Collection collection,
                                                        EntityImpl entityImpl)

Synchronize the dependent object with the persistence cache

#### Parameters

attributeIdentifier
  identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers

collection
  instance of a belonging

entityImpl
  implementation of an entity bean

### synchronizeWithCache(String, Map, EntityImpl) Method

    public static final Map synchronizeWithCache(String attributeIdentifier,
                                                 Map map,
                                                 EntityImpl entityImpl)

Synchronize the dependent object with the persistence cache

#### Parameters

attributeIdentifier
  identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers

map
  instance of a belonging

entityImpl
  implementation of an entity bean

### synchronizeWithCache(Belonging, EntityImpl) Method

    public static final Belonging synchronizeWithCache(Belonging value,
                                                       EntityImpl entityImpl)

Synchronize the dependent object with the persistence cache

#### Parameters

value
  identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers

entityImpl
  instance of a belonging

### synchronizeWithCache(Object, EntityImpl) Method

    public static final Object synchronizeWithCache(Object value,
                                                    EntityImpl entityImpl)

Synchronize the dependent object with the persistence cache

#### Parameters

value
  identifier for an attribute on a bean e.g. examples.buybeans.BeanieHat.numberOfPropellers

entityImpl
  instance of a belonging