com.beasys.commerce.util
Interface PersistenceHelperPlugin

public interface PersistenceHelperPlugin

Interface for Persistence Helper Plugin A specific driver must be written for each type of persistence cache. This is not a required optimization for CMP or BMP.

Method Summary

SmartCollectionReference	createSmartCollectionReference() Deprecated.
SmartCollectionReference	createSmartCollectionReference(java.lang.String attributeIdentifier, SmartCollectionReference targetInstance, Belonging belonging)
SmartCollectionReference	createSmartCollectionReference(java.lang.String attributeIdentifier, SmartCollectionReference targetInstance, javax.ejb.EnterpriseBean enterpriseBean)
SmartEntityReference	createSmartEntityReference()
SmartEntityReference	createSmartEntityReference(java.lang.String attributeIdentifier, SmartEntityReference targetInstance, Belonging belonging)
SmartEntityReference	createSmartEntityReference(java.lang.String attributeIdentifier, SmartEntityReference targetInstance, javax.ejb.EnterpriseBean enterpriseBean)
SmartMapReference	createSmartMapReference() Deprecated.
SmartMapReference	createSmartMapReference(java.lang.String attributeIdentifier, SmartMapReference targetInstance, Belonging belonging) Allocate an instance of a smart map
SmartMapReference	createSmartMapReference(java.lang.String attributeIdentifier, SmartMapReference targetInstance, javax.ejb.EnterpriseBean enterpriseBean) Allocate an instance of a smart map
Belonging	doRelationalBinding(java.lang.String attributeIdentifier, Belonging value, javax.ejb.EJBObject parent, BelongingImpl belongingImpl) The dependent object will have additional information for object-relational mapping
Belonging	doRelationalBinding(java.lang.String attributeIdentifier, Belonging value, EntityImpl entityImpl) The dependent object will have additional information for object-relational mapping
void	doRelationalBinding(java.lang.String attributeIdentifier, javax.ejb.EJBObject ejbObject, javax.ejb.EJBObject parent, BelongingImpl belongingImpl) The dependent object will have additional information for object-relational mapping
void	doRelationalBinding(java.lang.String attributeIdentifier, javax.ejb.EJBObject ejbObject, EntityImpl entityImpl) The dependent object will have additional information for object-relational mapping
java.lang.Object	doRelationalBinding(java.lang.String attributeIdentifier, java.lang.Object value, javax.ejb.EJBObject parent, BelongingImpl belongingImpl) The dependent object will have additional information for object-relational mapping
java.lang.Object	doRelationalBinding(java.lang.String attributeIdentifier, java.lang.Object value, EntityImpl entityImpl) The dependent object will have additional information for object-relational mapping
Belonging	doRelationalBindingWithMapKey(java.lang.String attributeIdentifier, Belonging value, java.lang.Object mapKey, javax.ejb.EJBObject parent, BelongingImpl belongingImpl) The dependent object will have additional information for object-relational mapping
Belonging	doRelationalBindingWithMapKey(java.lang.String attributeIdentifier, Belonging value, java.lang.Object mapKey, EntityImpl entityImpl) The dependent object will have additional information for object-relational mapping
void	doRelationalBindingWithMapKey(java.lang.String attributeIdentifier, javax.ejb.EJBObject ejbObject, java.lang.Object mapKey, javax.ejb.EJBObject parent, BelongingImpl belongingImpl) The dependent object will have additional information for object-relational mapping
void	doRelationalBindingWithMapKey(java.lang.String attributeIdentifier, javax.ejb.EJBObject ejbObject, java.lang.Object mapKey, EntityImpl entityImpl) The dependent object will have additional information for object-relational mapping
java.lang.Object	doRelationalBindingWithMapKey(java.lang.String attributeIdentifier, java.lang.Object value, java.lang.Object mapKey, javax.ejb.EJBObject parent, BelongingImpl belongingImpl) The dependent object will have additional information for object-relational mapping
java.lang.Object	doRelationalBindingWithMapKey(java.lang.String attributeIdentifier, java.lang.Object value, java.lang.Object mapKey, EntityImpl entityImpl) The dependent object will have additional information for object-relational mapping
Belonging	synchronizeWithCache(Belonging value, EntityImpl entityImpl) Optimize the dependent object in the persistence cache
java.lang.Object	synchronizeWithCache(java.lang.Object value, EntityImpl entityImpl) Optimize the dependent object in the persistence cache
Belonging	synchronizeWithCache(java.lang.String attributeIdentifier, Belonging value, EntityImpl entityImpl) Optimize the dependent object in the persistence cache
java.util.Collection	synchronizeWithCache(java.lang.String attributeIdentifier, java.util.Collection collection, EntityImpl entityImpl) Optimize the dependent object in the persistence cache
java.util.Map	synchronizeWithCache(java.lang.String attributeIdentifier, java.util.Map map, EntityImpl entityImpl) Optimize the dependent object in the persistence cache
java.lang.Object	synchronizeWithCache(java.lang.String attributeIdentifier, java.lang.Object value, EntityImpl entityImpl) Optimize the dependent object in the persistence cache

Method Detail

synchronizeWithCache

public Belonging synchronizeWithCache(java.lang.String attributeIdentifier,
                                      Belonging value,
                                      EntityImpl entityImpl)

Optimize the dependent object in 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

public java.lang.Object synchronizeWithCache(java.lang.String attributeIdentifier,
                                             java.lang.Object value,
                                             EntityImpl entityImpl)

Optimize the dependent object in 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

public java.util.Collection synchronizeWithCache(java.lang.String attributeIdentifier,
                                                 java.util.Collection collection,
                                                 EntityImpl entityImpl)

Optimize the dependent object in 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

public java.util.Map synchronizeWithCache(java.lang.String attributeIdentifier,
                                          java.util.Map map,
                                          EntityImpl entityImpl)

Optimize the dependent object in 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

public Belonging synchronizeWithCache(Belonging value,
                                      EntityImpl entityImpl)

Optimize the dependent object in the persistence cache

Parameters:

value - instance of a belonging

entityImpl - implementation of an entity bean

synchronizeWithCache

public java.lang.Object synchronizeWithCache(java.lang.Object value,
                                             EntityImpl entityImpl)

Optimize the dependent object in the persistence cache

Parameters:

value - instance of a belonging

entityImpl - implementation of an entity bean

doRelationalBinding

public Belonging doRelationalBinding(java.lang.String attributeIdentifier,
                                     Belonging value,
                                     EntityImpl entityImpl)

The dependent object will have additional information for object-relational mapping

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

doRelationalBinding

public java.lang.Object doRelationalBinding(java.lang.String attributeIdentifier,
                                            java.lang.Object value,
                                            EntityImpl entityImpl)

The dependent object will have additional information for object-relational mapping

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

doRelationalBinding

public void doRelationalBinding(java.lang.String attributeIdentifier,
                                javax.ejb.EJBObject ejbObject,
                                EntityImpl entityImpl)

The dependent object will have additional information for object-relational mapping

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

doRelationalBindingWithMapKey

public Belonging doRelationalBindingWithMapKey(java.lang.String attributeIdentifier,
                                               Belonging value,
                                               java.lang.Object mapKey,
                                               EntityImpl entityImpl)

The dependent object will have additional information for object-relational mapping

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

doRelationalBindingWithMapKey

public java.lang.Object doRelationalBindingWithMapKey(java.lang.String attributeIdentifier,
                                                      java.lang.Object value,
                                                      java.lang.Object mapKey,
                                                      EntityImpl entityImpl)

The dependent object will have additional information for object-relational mapping

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

doRelationalBindingWithMapKey

public void doRelationalBindingWithMapKey(java.lang.String attributeIdentifier,
                                          javax.ejb.EJBObject ejbObject,
                                          java.lang.Object mapKey,
                                          EntityImpl entityImpl)

The dependent object will have additional information for object-relational mapping

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

doRelationalBinding

public Belonging doRelationalBinding(java.lang.String attributeIdentifier,
                                     Belonging value,
                                     javax.ejb.EJBObject parent,
                                     BelongingImpl belongingImpl)

The dependent object will have additional information for object-relational mapping

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

doRelationalBinding

public java.lang.Object doRelationalBinding(java.lang.String attributeIdentifier,
                                            java.lang.Object value,
                                            javax.ejb.EJBObject parent,
                                            BelongingImpl belongingImpl)

The dependent object will have additional information for object-relational mapping

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

doRelationalBinding

public void doRelationalBinding(java.lang.String attributeIdentifier,
                                javax.ejb.EJBObject ejbObject,
                                javax.ejb.EJBObject parent,
                                BelongingImpl belongingImpl)

The dependent object will have additional information for object-relational mapping

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

doRelationalBindingWithMapKey

public Belonging doRelationalBindingWithMapKey(java.lang.String attributeIdentifier,
                                               Belonging value,
                                               java.lang.Object mapKey,
                                               javax.ejb.EJBObject parent,
                                               BelongingImpl belongingImpl)

The dependent object will have additional information for object-relational mapping

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

doRelationalBindingWithMapKey

public java.lang.Object doRelationalBindingWithMapKey(java.lang.String attributeIdentifier,
                                                      java.lang.Object value,
                                                      java.lang.Object mapKey,
                                                      javax.ejb.EJBObject parent,
                                                      BelongingImpl belongingImpl)

The dependent object will have additional information for object-relational mapping

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

doRelationalBindingWithMapKey

public void doRelationalBindingWithMapKey(java.lang.String attributeIdentifier,
                                          javax.ejb.EJBObject ejbObject,
                                          java.lang.Object mapKey,
                                          javax.ejb.EJBObject parent,
                                          BelongingImpl belongingImpl)

The dependent object will have additional information for object-relational mapping

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

createSmartMapReference

public SmartMapReference createSmartMapReference(java.lang.String attributeIdentifier,
                                                 SmartMapReference targetInstance,
                                                 javax.ejb.EnterpriseBean enterpriseBean)

Allocate an instance of a smart map

createSmartCollectionReference

public SmartCollectionReference createSmartCollectionReference(java.lang.String attributeIdentifier,
                                                               SmartCollectionReference targetInstance,
                                                               javax.ejb.EnterpriseBean enterpriseBean)

createSmartMapReference

public SmartMapReference createSmartMapReference(java.lang.String attributeIdentifier,
                                                 SmartMapReference targetInstance,
                                                 Belonging belonging)

Allocate an instance of a smart map

createSmartCollectionReference

public SmartCollectionReference createSmartCollectionReference(java.lang.String attributeIdentifier,
                                                               SmartCollectionReference targetInstance,
                                                               Belonging belonging)

createSmartMapReference

public SmartMapReference createSmartMapReference()

Deprecated.

createSmartCollectionReference

public SmartCollectionReference createSmartCollectionReference()

Deprecated.

createSmartEntityReference

public SmartEntityReference createSmartEntityReference(java.lang.String attributeIdentifier,
                                                       SmartEntityReference targetInstance,
                                                       javax.ejb.EnterpriseBean enterpriseBean)

createSmartEntityReference

public SmartEntityReference createSmartEntityReference(java.lang.String attributeIdentifier,
                                                       SmartEntityReference targetInstance,
                                                       Belonging belonging)

createSmartEntityReference

public SmartEntityReference createSmartEntityReference()