Package de.xima.fc.plugin.models.params.entities

Class PluginEntitiesParams

java.lang.Object

de.xima.fc.plugin.models.params.entities.PluginEntitiesParams

All Implemented Interfaces:

IPluginParameters, IPluginEntitiesParams, Serializable

public class PluginEntitiesParams
extends Object
implements IPluginEntitiesParams

Implementation of the IPluginEntitiesParams. The required data are passed to the constructor, which are then available via the getter methods.

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PluginEntitiesParams(javax.persistence.EntityManagerFactory entityManagerFactory, IPluginEmManager pluginEmManager)

Method Summary

Modifier and Type	Method	Description
javax.persistence.EntityManagerFactory	getEntityManagerFactory()	Returns the EntityManagerFactory the plugin should use to create new EntityManagers.
IPluginEmManager	getPluginEmManager()	To make it easier to work with entities, you can use the em manager provided by this method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginEntitiesParams

public PluginEntitiesParams(javax.persistence.EntityManagerFactory entityManagerFactory,
                            IPluginEmManager pluginEmManager)

Parameters:

entityManagerFactory - The EntityManagerFactory that will be passed to the entities plugin.

pluginEmManager - The IPluginEmManager that will be passed to the entities plugin.

Method Detail

getEntityManagerFactory

public javax.persistence.EntityManagerFactory getEntityManagerFactory()

Description copied from interface: IPluginEntitiesParams

Returns the EntityManagerFactory the plugin should use to create new EntityManagers. The entity manager lets you create new entities, query for existing entities or delete entities. This is a low-level API method, consider using IPluginEntitiesParams.getPluginEmManager() instead.

Specified by:

getEntityManagerFactory in interface IPluginEntitiesParams

Returns:

An EntityManagerFactory for creating a new EntityManager.

See Also:

IPluginEntitiesParams.getPluginEmManager()

getPluginEmManager

public IPluginEmManager getPluginEmManager()

Description copied from interface: IPluginEntitiesParams

To make it easier to work with entities, you can use the em manager provided by this method. See IPluginEmManager for more details on how to use it.

Specified by:

getPluginEmManager in interface IPluginEntitiesParams

Returns:

A manager for the EntityManager that also lets you create an IBaseEntityContext that can be used with the DAO API of formcycle.