public interface Lifecycle
Provides callbacks from the <tt>Session</tt> to the persistent object. Persistent classes <b>may</b> implement this interface but they are not required to.<br> <br> <b>onSave:</b> called just before the object is saved<br> <b>onUpdate:</b> called just before an object is updated, ie. when <tt>Session.update()</tt> is called<br> <b>onDelete:</b> called just before an object is deleted<br> <b>onLoad:</b> called just after an object is loaded<br> <br> <tt>onLoad()</tt> may be used to initialize transient properties of the object from its persistent state. It may <b>not</b> be used to load dependent objects since the <tt>Session</tt> interface may not be invoked from inside this method.<br> <br> A further intended usage of <tt>onLoad()</tt>, <tt>onSave()</tt> and <tt>onUpdate()</tt> is to store a reference to the <tt>Session</tt> for later use.<br> <br> If <tt>onSave()</tt>, <tt>onUpdate()</tt> or <tt>onDelete()</tt> return <tt>VETO</tt>, the operation is silently vetoed. If a <tt>CallbackException</tt> is thrown, the operation is vetoed and the exception is passed back to the application.<br> <br> Note that <tt>onSave()</tt> is called after an identifier is assigned to the object, except when identity column key generation is used.
CallbackException
Modifier and Type | Field and Description |
---|---|
static boolean |
NO_VETO
Return value to accept the action (false)
|
static boolean |
VETO
Return value to veto the action (true)
|
Modifier and Type | Method and Description |
---|---|
boolean |
onDelete(Session s)
Called when an entity is deleted.
|
void |
onLoad(Session s,
Serializable id)
Called after an entity is loaded.
|
boolean |
onSave(Session s)
Called when an entity is saved.
|
boolean |
onUpdate(Session s)
Called when an entity is passed to <tt>Session.update()</tt>.
|
static final boolean VETO
Return value to veto the action (true)
static final boolean NO_VETO
Return value to accept the action (false)
boolean onSave(Session s) throws CallbackException
Called when an entity is saved.
s
- the sessionCallbackException
- Indicates a problem happened during callbackboolean onUpdate(Session s) throws CallbackException
Called when an entity is passed to <tt>Session.update()</tt>. This method is <em>not</em> called every time the object’s state is persisted during a flush.
s
- the sessionCallbackException
- Indicates a problem happened during callbackboolean onDelete(Session s) throws CallbackException
Called when an entity is deleted.
s
- the sessionCallbackException
- Indicates a problem happened during callbackvoid onLoad(Session s, Serializable id)
Called after an entity is loaded. <em>It is illegal to access the <tt>Session</tt> from inside this method.</em> However, the object may keep a reference to the session for later use.
s
- the sessionid
- the identifierCopyright © 2001-2018 Red Hat, Inc. All Rights Reserved.