Keel 2.1RC2

org.keel.services.persist
Interface Helper

All Known Implementing Classes:
AbstractHelper

public interface Helper

A "Helper" is an object that is related to a particular persistent object, containing methods and logic that are connected logically to the persistent object itself. It also receives events whenever the persistent object is updated, read, etc


Method Summary
 void afterAdd(Persistent current)
          Called after the Add operation is completed successfully
 void afterDelete(Persistent current)
          Called after the Delete operation is performed
 void afterQuery(Persistent current)
          Called after a query operation
 void afterSetField(java.lang.String fieldName, java.lang.Object oldValue, java.lang.Object newValue)
          Called after a field is changed, assuming the change was allowed (e.g.
 void afterUpdate(Persistent current)
          Called after the Update operation is performed
 void beforeAdd(Persistent current)
          Called before the Add operation is performed
 void beforeClear(Persistent current)
          Called before the Clear operation is performed
 void beforeDelete(Persistent current)
          Called before the Delete operation is performed
 void beforeQuery(Persistent current)
          Called before the query operation is performed
 void beforeSetField(java.lang.String fieldName, java.lang.Object oldValue, java.lang.Object newValue)
          Called before each access to set the field value of a Persistent
 void beforeUpdate(Persistent current)
          Called before the Update operation is performed
 void setPersistent(Persistent current)
          Called when the helper is first instantiated
 

Method Detail

setPersistent

public void setPersistent(Persistent current)
Called when the helper is first instantiated


beforeAdd

public void beforeAdd(Persistent current)
Called before the Add operation is performed

Parameters:
current - The Persistent object before the add operation. Fields such as auto-incremented keys will not yet have their values assigned.

afterAdd

public void afterAdd(Persistent current)
Called after the Add operation is completed successfully

Parameters:
current - The Persistent object after the add operation. Fields such as auto-incremented keys will have their values assigned properly

beforeDelete

public void beforeDelete(Persistent current)
Called before the Delete operation is performed

Parameters:
current - The Persistent object about to be deleted

beforeUpdate

public void beforeUpdate(Persistent current)
Called before the Update operation is performed

Parameters:
current - The Persistent object before the update

afterUpdate

public void afterUpdate(Persistent current)
Called after the Update operation is performed

Parameters:
current - The Persistent object that has just been updated

afterDelete

public void afterDelete(Persistent current)
Called after the Delete operation is performed

Parameters:
current - The Persistent object which has just been deleted

beforeClear

public void beforeClear(Persistent current)
Called before the Clear operation is performed

Parameters:
current - The Persistent object before it is cleared

beforeSetField

public void beforeSetField(java.lang.String fieldName,
                           java.lang.Object oldValue,
                           java.lang.Object newValue)
Called before each access to set the field value of a Persistent

Parameters:
fieldName - The field name whose value is being altered
oldValue - The field value before the changed is applied

afterSetField

public void afterSetField(java.lang.String fieldName,
                          java.lang.Object oldValue,
                          java.lang.Object newValue)
Called after a field is changed, assuming the change was allowed (e.g. by validations, type, etc)

Parameters:
fieldName - The field name that was changed
oldValue - The field value before the change
newValue - The updated field value

beforeQuery

public void beforeQuery(Persistent current)
Called before the query operation is performed

Parameters:
current - The Persistent object before the query - contains the constraint values that will be used to perform the query itself

afterQuery

public void afterQuery(Persistent current)
Called after a query operation

Parameters:
current - The Persistent object after the query - essentially identical to before

Keel 2.1RC2

Please see keelframework.org for information about new Keel releases.