org.nuiton.topia.persistence

Interface TopiaEntity

All Superinterfaces:

Serializable

All Known Subinterfaces:

TopiaEntityContextable

All Known Implementing Classes:

TopiaEntityAbstract

public interface TopiaEntity
extends Serializable

The TopiaEntity is the main interface for each entity generated with TopiaMetaTransformer. An entity is simply a persistent bean mapped with Hibernate. The manipulation on entities (create, update, delete, find) is made by the DAO associated. The corresponding DAO interface is TopiaDAO.

Setter methods have to be used only in internal. They are in the interface to make easier their usages in internal.

Version:

$Id: TopiaEntity.java 2775 2013-07-19 23:32:02Z athimel $

Author:

poussin , fdesbois

See Also:

EntityHibernateMappingGenerator, EntityTransformer

Field Summary

Fields

Modifier and Type	Field and Description
static String	AGGREGATE Deprecated. since 3.0, will be removed in 3.1, unused
static String	COMPOSITE Deprecated. since 3.0, will be removed in 3.1, unused
static String	PROPERTY_TOPIA_CREATE_DATE
static String	PROPERTY_TOPIA_ID
static String	PROPERTY_TOPIA_VERSION
static String	TOPIA_CREATE_DATE Deprecated. since 3.0, will be removed in 3.1, use PROPERTY_TOPIA_CREATE_DATE instead
static String	TOPIA_ID Deprecated. since 3.0, will be removed in 3.1, use PROPERTY_TOPIA_ID instead
static String	TOPIA_VERSION Deprecated. since 3.0, will be removed in 3.1, use PROPERTY_TOPIA_VERSION instead

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(EntityVisitor visitor) Route the entity using a visitor.
void	addPropertyChangeListener(PropertyChangeListener listener) Add listener for property writing.
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener) Add listener for property writing.
void	addPropertyListener(PropertyChangeListener listener) Add listener for property reading.
void	addPropertyListener(String propertyName, PropertyChangeListener listener) Add listener for property reading.
void	addVetoableChangeListener(String propertyName, VetoableChangeListener vetoable)
void	addVetoableChangeListener(VetoableChangeListener vetoable)
void	addVetoableListener(String propertyName, VetoableChangeListener vetoable)
void	addVetoableListener(VetoableChangeListener vetoable)
List<TopiaEntity>	getAggregate() Deprecated. from 3.0, method will be moved to entity's generated DAO (cf http://nuiton.org/issues/2776)
List<TopiaEntity>	getComposite() Deprecated. from 3.0, method will be moved to entity's generated DAO (cf http://nuiton.org/issues/2776)
Date	getTopiaCreateDate() Technical date creation of the entity.
String	getTopiaId() Unique technical Id of the entity.
long	getTopiaVersion() Technical property to keep versionning of the entity.
boolean	isPersisted() This method must be used to know if the current entity is present on the persistent support.
void	notifyDeleted() Notifies the current entity instance than it has been removed from the persistent support.
void	removePropertyChangeListener(PropertyChangeListener listener)
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
void	removePropertyListener(PropertyChangeListener listener)
void	removePropertyListener(String propertyName, PropertyChangeListener listener)
void	removeVetoableChangeListener(String propertyName, VetoableChangeListener vetoable)
void	removeVetoableChangeListener(VetoableChangeListener vetoable)
void	removeVetoableListener(String propertyName, VetoableChangeListener vetoable)
void	removeVetoableListener(VetoableChangeListener vetoable)
void	setTopiaCreateDate(Date date) Set the technical creation date of the entity.
void	setTopiaId(String id) Set the technical id of the entity.
void	setTopiaVersion(long version) Set the technical version of the entity.

Field Detail

PROPERTY_TOPIA_ID

static final String PROPERTY_TOPIA_ID

See Also:

Constant Field Values

TOPIA_ID

@Deprecated
static final String TOPIA_ID

Deprecated. since 3.0, will be removed in 3.1, use PROPERTY_TOPIA_ID instead

See Also:

Constant Field Values

PROPERTY_TOPIA_CREATE_DATE

static final String PROPERTY_TOPIA_CREATE_DATE

See Also:

Constant Field Values

TOPIA_CREATE_DATE

@Deprecated
static final String TOPIA_CREATE_DATE

Deprecated. since 3.0, will be removed in 3.1, use PROPERTY_TOPIA_CREATE_DATE instead

See Also:

Constant Field Values

PROPERTY_TOPIA_VERSION

static final String PROPERTY_TOPIA_VERSION

See Also:

Constant Field Values

TOPIA_VERSION

@Deprecated
static final String TOPIA_VERSION

Deprecated. since 3.0, will be removed in 3.1, use PROPERTY_TOPIA_VERSION instead

See Also:

Constant Field Values

COMPOSITE

@Deprecated
static final String COMPOSITE

Deprecated. since 3.0, will be removed in 3.1, unused

See Also:

Constant Field Values

AGGREGATE

@Deprecated
static final String AGGREGATE

Deprecated. since 3.0, will be removed in 3.1, unused

See Also:

Constant Field Values

Method Detail

getTopiaId

String getTopiaId()

Unique technical Id of the entity. This id contains the full qualified name of the entity interface. This id has also an index and is used to identify uniquely the entity in the database.

Returns:

the technical Id of the entity

setTopiaId

void setTopiaId(String id)

Set the technical id of the entity. Careful, use this method only for copy. The technical id is generated by ToPIA when entity is created using TopiaDAO.create(Object...).

Parameters:

id - technical id to set

getTopiaVersion

long getTopiaVersion()

Technical property to keep versionning of the entity. The version is incremented on each change of the entity.

Returns:

the current version of the entity

setTopiaVersion

void setTopiaVersion(long version)

Set the technical version of the entity. Careful, use this method only for copy. The version is automatically incremented on entity changes.

Parameters:

version - technical version to set

getTopiaCreateDate

Date getTopiaCreateDate()

Technical date creation of the entity. This date doesn't change through time and was initialized on entity creation when using TopiaDAO.create(Object...).

Returns:

the creation date of the entity

setTopiaCreateDate

void setTopiaCreateDate(Date date)

Set the technical creation date of the entity. Careful, use this method only for copy. This date is immutable and was created on entity creation.

Parameters:

date - technical create date to set

isPersisted

boolean isPersisted()

This method must be used to know if the current entity is present on the persistent support. If the entity is not yet persisted or if the entity has been removed, this method will return false.

Returns:

true if the entity is persisted and not yet deleted

Since:

3.0

notifyDeleted

void notifyDeleted()

Notifies the current entity instance than it has been removed from the persistent support.

Since:

3.0

getComposite

@Deprecated
List<TopiaEntity> getComposite()
                               throws TopiaException

Deprecated. from 3.0, method will be moved to entity's generated DAO (cf http://nuiton.org/issues/2776)

Returns:

all object that must be deleted if this object is deleted

Throws:

TopiaException - if any pb

getAggregate

@Deprecated
List<TopiaEntity> getAggregate()
                               throws TopiaException

Deprecated. from 3.0, method will be moved to entity's generated DAO (cf http://nuiton.org/issues/2776)

Returns:

all object that are aggregate with this instance, aggreate object are not removed automaticaly

Throws:

TopiaException - if any pb

accept

void accept(EntityVisitor visitor)
            throws TopiaException

Route the entity using a visitor.

Parameters:

visitor - to used

Throws:

TopiaException - for all type of error

addPropertyListener

void addPropertyListener(PropertyChangeListener listener)

Add listener for property reading.

Parameters:

listener - the listener to register

addPropertyListener

void addPropertyListener(String propertyName,
                       PropertyChangeListener listener)

Add listener for property reading.

Parameters:

propertyName - the property name to listen

listener - the listener to register

removePropertyListener

void removePropertyListener(PropertyChangeListener listener)

removePropertyListener

void removePropertyListener(String propertyName,
                          PropertyChangeListener listener)

addPropertyChangeListener

void addPropertyChangeListener(PropertyChangeListener listener)

Add listener for property writing.

Parameters:

listener - the listener to register

addPropertyChangeListener

void addPropertyChangeListener(String propertyName,
                             PropertyChangeListener listener)

Add listener for property writing.

Parameters:

propertyName - name of property to listen

listener - the listener to register

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener listener)

removePropertyChangeListener

void removePropertyChangeListener(String propertyName,
                                PropertyChangeListener listener)

addVetoableListener

void addVetoableListener(VetoableChangeListener vetoable)

addVetoableListener

void addVetoableListener(String propertyName,
                       VetoableChangeListener vetoable)

removeVetoableListener

void removeVetoableListener(VetoableChangeListener vetoable)

removeVetoableListener

void removeVetoableListener(String propertyName,
                          VetoableChangeListener vetoable)

addVetoableChangeListener

void addVetoableChangeListener(VetoableChangeListener vetoable)

addVetoableChangeListener

void addVetoableChangeListener(String propertyName,
                             VetoableChangeListener vetoable)

removeVetoableChangeListener

void removeVetoableChangeListener(VetoableChangeListener vetoable)

removeVetoableChangeListener

void removeVetoableChangeListener(String propertyName,
                                VetoableChangeListener vetoable)