EntityEditModel (JMinor Framework API 0.12.5-SNAPSHOT)

All Superinterfaces:

EntityDataProvider, Refreshable, ValueMapEditModel<Property,java.lang.Object>

All Known Implementing Classes:

DefaultEntityEditModel, FXEntityEditModel, SwingEntityEditModel
```
public interface EntityEditModel
extends ValueMapEditModel<Property,java.lang.Object>, Refreshable, EntityDataProvider
```
Specifies a class for editing Entity instances.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`EntityEditModel.DeleteEvent` An event describing a delete action.
`static interface`	`EntityEditModel.InsertEvent` An event describing a insert action.
`static interface`	`EntityEditModel.UpdateEvent` An event describing a update action.

Field Summary

Fields
Modifier and Type	Field and Description
`static PropertyValue<java.lang.String>`	`COMBO_BOX_NULL_VALUE_ITEM` Specifies the value used by default to represent a null value in combo box models.
`static PropertyValue<java.lang.Boolean>`	`PERSIST_FOREIGN_KEY_VALUES` Specifies whether foreign key values should persist when the UI is cleared or be reset to null Value type: Boolean Default value: true
`static PropertyValue<java.lang.Boolean>`	`WARN_ABOUT_UNSAVED_DATA` Indicates whether the application should ask for confirmation when exiting if some data is unsaved and whether it should warn when unsaved data is about to be lost due to selection changes f.ex.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addAfterDeleteListener(EventDataListener<EntityEditModel.DeleteEvent> listener)`
`void`	`addAfterInsertListener(EventDataListener<EntityEditModel.InsertEvent> listener)`
`void`	`addAfterRefreshListener(EventListener listener)`
`void`	`addAfterUpdateListener(EventDataListener<EntityEditModel.UpdateEvent> listener)`
`void`	`addBeforeDeleteListener(EventDataListener<EntityEditModel.DeleteEvent> listener)`
`void`	`addBeforeInsertListener(EventDataListener<EntityEditModel.InsertEvent> listener)`
`void`	`addBeforeRefreshListener(EventListener listener)`
`void`	`addBeforeUpdateListener(EventDataListener<EntityEditModel.UpdateEvent> listener)`
`void`	`addConfirmSetEntityObserver(EventDataListener<State> listener)`
`void`	`addEntitiesChangedListener(EventListener listener)`
`void`	`addEntitySetListener(EventDataListener<Entity> listener)`
`void`	`addForeignKeyValues(java.util.List<Entity> values)` Adds the inserted entities to all foreign key models based on that entity type
`void`	`addValueListener(java.lang.String propertyId, EventDataListener<ValueChange<Property,java.lang.Object>> listener)` Adds a listener notified each time the value associated with the given key changes
`void`	`addValueSetListener(java.lang.String propertyId, EventDataListener<ValueChange<Property,java.lang.Object>> listener)` Adds a listener notified each time the value associated with the given property is set via `ValueMapEditModel.put(Object, Object)`, note that this event is only fired when the the value changes
`boolean`	`containsLookupModel(java.lang.String foreignKeyPropertyId)` Returns true if this edit model contains a `EntityLookupModel` for the given foreign key property
`boolean`	`containsUnsavedData()` Returns true if an entity is selected and a value has been modified or if the entity is new and one or more non-default values have been entered
`EntityLookupModel`	`createForeignKeyLookupModel(ForeignKeyProperty foreignKeyProperty)` Creates a `EntityLookupModel` for looking up entities referenced by the given foreign key property, using the search properties defined for that entity type, or if none are defined all string based searchable properties in that entity.
`java.util.List<Entity>`	`delete()` Deletes the active entity
`java.util.List<Entity>`	`delete(java.util.List<Entity> entities)` Deletes the given entities, returns silently on receiving an empty list
`java.lang.Object`	`get(java.lang.String propertyId)` Returns the value associated with the given property
`StateObserver`	`getAllowDeleteObserver()`
`StateObserver`	`getAllowInsertObserver()`
`StateObserver`	`getAllowUpdateObserver()`
`Entity`	`getDefaultEntity()`
`java.lang.Object`	`getDefaultValue(Property property)` Returns the default value for the given property, used when initializing a new default entity for this edit model.
`Domain`	`getDomain()`
`Entity`	`getEntityCopy()`
`Entity`	`getEntityCopy(boolean includePrimaryKeyValues)`
`Entity.Definition`	`getEntityDefinition()`
`StateObserver`	`getEntityNewObserver()`
`Entity`	`getForeignKey(java.lang.String foreignKeyPropertyId)` Returns the value associated with the given propertyId assuming it is an `Entity` instance
`EntityLookupModel`	`getForeignKeyLookupModel(ForeignKeyProperty foreignKeyProperty)`
`EntityLookupModel`	`getForeignKeyLookupModel(java.lang.String foreignKeyPropertyId)`
`StateObserver`	`getModifiedObserver()` Returns a StateObserver responsible for indicating when and if any values in the underlying Entity are modified.
`StateObserver`	`getPrimaryKeyNullObserver()`
`EventObserver<ValueChange<Property,java.lang.Object>>`	`getValueObserver(java.lang.String propertyId)`
`ValueCollectionProvider`	`getValueProvider(Property property)` Initializes a value provider for the given property, useful for adding lookup functionality to input fields for example.
`java.util.List<Entity>`	`insert()` Performs a insert on the active entity, sets the primary key values of the active entity according to the primary key of the inserted entity
`java.util.List<Entity>`	`insert(java.util.List<Entity> entities)` Performs an insert on the given entities, returns silently on receiving an empty list
`boolean`	`isDeleteAllowed()`
`boolean`	`isEntityNew()` Returns true if the active entity is new or false if it represents a row already persisted.
`boolean`	`isInsertAllowed()`
`boolean`	`isLookupAllowed(Property property)` Returns true if values based on this property should be available for lookup via this EditModel.
`boolean`	`isModified()`
`boolean`	`isNotNull(java.lang.String propertyId)`
`boolean`	`isNull(java.lang.String propertyId)`
`boolean`	`isReadOnly()`
`boolean`	`isUpdateAllowed()`
`boolean`	`isValuePersistent(Property property)` Returns true if the last available value for this property should be used when initializing a default entity.
`boolean`	`isWarnAboutUnsavedData()`
`void`	`put(java.lang.String propertyId, java.lang.Object value)` Sets the given value in the underlying value map
`void`	`refreshEntity()` Refreshes the active Entity from the database, discarding all changes.
`java.lang.Object`	`remove(java.lang.String propertyId)` Removes the given value from the underlying value map
`void`	`removeAfterDeleteListener(EventDataListener listener)`
`void`	`removeAfterInsertListener(EventDataListener listener)`
`void`	`removeAfterRefreshListener(EventListener listener)`
`void`	`removeAfterUpdateListener(EventDataListener listener)`
`void`	`removeBeforeDeleteListener(EventDataListener listener)`
`void`	`removeBeforeInsertListener(EventDataListener listener)`
`void`	`removeBeforeRefreshListener(EventListener listener)`
`void`	`removeBeforeUpdateListener(EventDataListener listener)`
`void`	`removeConfirmSetEntityObserver(EventDataListener listener)`
`void`	`removeEntitiesChangedListener(EventListener listener)`
`void`	`removeEntitySetListener(EventDataListener listener)`
`void`	`removeForeignKeyValues(java.util.List<Entity> values)` Removes the deleted entities from all foreign key models based on that entity type todo set foreign key values referencing the deleted entity to null
`void`	`removeValueListener(java.lang.String propertyId, EventDataListener listener)`
`void`	`removeValueSetListener(java.lang.String propertyId, EventDataListener listener)`
`void`	`replaceForeignKeyValues(java.lang.String foreignKeyEntityId, java.util.Collection<Entity> foreignKeyValues)` For every field referencing the given foreign key values, replaces that foreign key instance with the corresponding entity from `foreignKeyValues`, useful when property values have been changed in the referenced entity that must be reflected in the edit model.
`EntityEditModel`	`setDeleteAllowed(boolean value)`
`void`	`setEntity(Entity entity)` Copies the values from the given `Entity` into the underlying `Entity` being edited by this edit model.
`void`	`setForeignKeyValues(java.util.List<Entity> values)` Sets the values in the given list as the values for the respective foreign keys, uses the first value found for each entity type in case of multiple entities of that type
`EntityEditModel`	`setInsertAllowed(boolean value)`
`EntityEditModel`	`setReadOnly(boolean readOnly)` Makes this model read-only by disallowing insert, update and delete
`EntityEditModel`	`setUpdateAllowed(boolean value)`
`EntityEditModel`	`setValuePersistent(java.lang.String propertyId, boolean persistValueOnClear)`
`EntityEditModel`	`setWarnAboutUnsavedData(boolean warnAboutUnsavedData)`
`java.util.List<Entity>`	`update()` Performs a update on the active entity
`java.util.List<Entity>`	`update(java.util.List<Entity> entities)` Updates the given entities.
`<V> Value<V>`	`value(java.lang.String propertyId)` Instantiates a new Value based on the value identified by `propertyId` in this edit model

Methods inherited from interface org.jminor.common.model.valuemap.ValueMapEditModel
addValueListener, addValueSetListener, get, getValidator, getValidObserver, getValueObserver, getValueObserver, isNotNull, isNull, isNullable, isValid, isValid, put, remove, removeValueListener, removeValueSetListener, validate, validate, validate, validate

Methods inherited from interface org.jminor.common.model.Refreshable
clear, refresh

Methods inherited from interface org.jminor.framework.model.EntityDataProvider
getConnectionProvider, getEntityId

- Field Detail
  - PERSIST_FOREIGN_KEY_VALUES
```
static final PropertyValue<java.lang.Boolean> PERSIST_FOREIGN_KEY_VALUES
```
    Specifies whether foreign key values should persist when the UI is cleared or be reset to null
    Value type: Boolean
    Default value: true
  - WARN_ABOUT_UNSAVED_DATA
```
static final PropertyValue<java.lang.Boolean> WARN_ABOUT_UNSAVED_DATA
```
    Indicates whether the application should ask for confirmation when exiting if some data is unsaved
    and whether it should warn when unsaved data is about to be lost due to selection changes f.ex. Value type: Boolean
    Default value: false
  - COMBO_BOX_NULL_VALUE_ITEM
```
static final PropertyValue<java.lang.String> COMBO_BOX_NULL_VALUE_ITEM
```
    Specifies the value used by default to represent a null value in combo box models. Using the value null indicates that no null value item should be used.
    Value type: String
    Default value: -
- Method Detail
  - getDefaultEntity
```
Entity getDefaultEntity()
```
    Returns:
    
    an Entity instance populated with default values for all properties
    
    See Also:
    
    getDefaultValue(Property)
  - setEntity
```
void setEntity(Entity entity)
```
    Copies the values from the given Entity into the underlying Entity being edited by this edit model. If entity is null then the entity being edited is populated with default values
    
    Parameters:
    
    entity - the entity
  - refreshEntity
```
void refreshEntity()
```
    Refreshes the active Entity from the database, discarding all changes. If the active Entity is new then calling this method has no effect.
  - getEntityCopy
```
Entity getEntityCopy()
```
    Returns:
    
    a deep copy of the active entity
    
    See Also:
    
    ValueMap.getCopy()
  - getEntityCopy
```
Entity getEntityCopy(boolean includePrimaryKeyValues)
```
    Parameters:
    
    includePrimaryKeyValues - if false then the primary key values are excluded
    
    Returns:
    
    a deep copy of the active entity
    
    See Also:
    
    ValueMap.getCopy()
  - isEntityNew
```
boolean isEntityNew()
```
    Returns true if the active entity is new or false if it represents a row already persisted. By default an entity is new if either its primary key or the original primary key are null. It is not recommended to base the result of this function on a database query since it is called frequently, as in, every time a property value changes.
    
    Returns:
    
    true if the active entity is new, that is, does not represent a persistent row
    
    See Also:
    
    getPrimaryKeyNullObserver(), Entity.isKeyNull()
  - containsUnsavedData
```
boolean containsUnsavedData()
```
    Returns true if an entity is selected and a value has been modified or if the entity is new and one or more non-default values have been entered
    
    Returns:
    
    true if this edit model contains unsaved data
    
    See Also:
    
    WARN_ABOUT_UNSAVED_DATA
  - isNull
```
boolean isNull(java.lang.String propertyId)
```
    Parameters:
    
    propertyId - the ID of the property
    
    Returns:
    
    true if the value of the given property is null
  - isNotNull
```
boolean isNotNull(java.lang.String propertyId)
```
    Parameters:
    
    propertyId - the ID of the property
    
    Returns:
    
    true if the value of the given property is not null
  - put
```
void put(java.lang.String propertyId,
         java.lang.Object value)
```
    Sets the given value in the underlying value map
    
    Parameters:
    
    propertyId - the ID of the property to associate the given value with
    
    value - the value to associate with the given property
  - remove
```
java.lang.Object remove(java.lang.String propertyId)
```
    Removes the given value from the underlying value map
    
    Parameters:
    
    propertyId - the ID of the property
    
    Returns:
    
    the value, if any
  - get
```
java.lang.Object get(java.lang.String propertyId)
```
    Returns the value associated with the given property
    
    Parameters:
    
    propertyId - the ID of the property
    
    Returns:
    
    the value associated with the given property
  - getForeignKey
```
Entity getForeignKey(java.lang.String foreignKeyPropertyId)
```
    Returns the value associated with the given propertyId assuming it is an Entity instance
    
    Parameters:
    
    foreignKeyPropertyId - the ID of the property
    
    Returns:
    
    the value assuming it is an Entity
    
    Throws:
    
    java.lang.ClassCastException - in case the value was not an Entity
  - replaceForeignKeyValues
```
void replaceForeignKeyValues(java.lang.String foreignKeyEntityId,
                             java.util.Collection<Entity> foreignKeyValues)
```
    For every field referencing the given foreign key values, replaces that foreign key instance with the corresponding entity from foreignKeyValues, useful when property values have been changed in the referenced entity that must be reflected in the edit model.
    
    Parameters:
    
    foreignKeyEntityId - the entity ID of the foreign key values
    
    foreignKeyValues - the new foreign key entities
  - getValueProvider
```
ValueCollectionProvider getValueProvider(Property property)
```
    Initializes a value provider for the given property, useful for adding lookup functionality to input fields for example.
    
    Parameters:
    
    property - the property
    
    Returns:
    
    a value provider for the given property
  - value
```
<V> Value<V> value(java.lang.String propertyId)
```
    Instantiates a new Value based on the value identified by propertyId in this edit model
    
    Type Parameters:
    
    V - the value type
    
    Parameters:
    
    propertyId - the property id
    
    Returns:
    
    a Value based on the given edit model value
  - getDomain
```
Domain getDomain()
```
    Returns:
    
    the underlying domain model
  - getEntityDefinition
```
Entity.Definition getEntityDefinition()
```
    Returns:
    
    the definition of the underlying entity
  - isReadOnly
```
boolean isReadOnly()
```
    Returns:
    
    true if this model is read only, that is if insert, update and delete are not allowed
    
    See Also:
    
    isInsertAllowed(), isUpdateAllowed(), isDeleteAllowed()
  - setReadOnly
```
EntityEditModel setReadOnly(boolean readOnly)
```
    Makes this model read-only by disallowing insert, update and delete
    
    Parameters:
    
    readOnly - the read only status
    
    Returns:
    
    this edit model instance
    
    See Also:
    
    setInsertAllowed(boolean), setUpdateAllowed(boolean), setDeleteAllowed(boolean)
  - isWarnAboutUnsavedData
```
boolean isWarnAboutUnsavedData()
```
    Returns:
    
    true if this model warns about unsaved data
    
    See Also:
    
    WARN_ABOUT_UNSAVED_DATA
  - setWarnAboutUnsavedData
```
EntityEditModel setWarnAboutUnsavedData(boolean warnAboutUnsavedData)
```
    Parameters:
    
    warnAboutUnsavedData - if true then this model warns about unsaved data
    
    Returns:
    
    this edit model instance
    
    See Also:
    
    WARN_ABOUT_UNSAVED_DATA
  - isInsertAllowed
```
boolean isInsertAllowed()
```
    Returns:
    
    true if this model should allow records to be inserted
  - setInsertAllowed
```
EntityEditModel setInsertAllowed(boolean value)
```
    Parameters:
    
    value - true if this model should allow inserts
    
    Returns:
    
    this edit model instance
  - isUpdateAllowed
```
boolean isUpdateAllowed()
```
    Returns:
    
    true if this model should allow records to be updated
  - setUpdateAllowed
```
EntityEditModel setUpdateAllowed(boolean value)
```
    Parameters:
    
    value - true if this model should allow records to be updated
    
    Returns:
    
    this edit model instance
  - isDeleteAllowed
```
boolean isDeleteAllowed()
```
    Returns:
    
    true if this model should allow records to be deleted
  - setDeleteAllowed
```
EntityEditModel setDeleteAllowed(boolean value)
```
    Parameters:
    
    value - true if this model should allow records to be deleted
    
    Returns:
    
    this edit model instance
  - createForeignKeyLookupModel
```
EntityLookupModel createForeignKeyLookupModel(ForeignKeyProperty foreignKeyProperty)
```
    Creates a EntityLookupModel for looking up entities referenced by the given foreign key property, using the search properties defined for that entity type, or if none are defined all string based searchable properties in that entity.
    
    Parameters:
    
    foreignKeyProperty - the foreign key property for which to create a EntityLookupModel
    
    Returns:
    
    a EntityLookupModel for looking up entities of the type referenced by the given foreign key property,
    
    Throws:
    
    java.lang.IllegalStateException - in case no searchable properties can be found for the entity type referenced by the given foreign key property
  - containsLookupModel
```
boolean containsLookupModel(java.lang.String foreignKeyPropertyId)
```
    Returns true if this edit model contains a EntityLookupModel for the given foreign key property
    
    Parameters:
    
    foreignKeyPropertyId - the ID of the property
    
    Returns:
    
    true if a EntityLookupModel has been initialized for the given foreign key property
  - getForeignKeyLookupModel
```
EntityLookupModel getForeignKeyLookupModel(java.lang.String foreignKeyPropertyId)
```
    Parameters:
    
    foreignKeyPropertyId - the ID of the property for which to retrieve the EntityLookupModel
    
    Returns:
    
    the EntityLookupModel associated with the property, if no lookup model has been initialized for the given property, a new one is created, associated with the property and returned.
  - getForeignKeyLookupModel
```
EntityLookupModel getForeignKeyLookupModel(ForeignKeyProperty foreignKeyProperty)
```
    Parameters:
    
    foreignKeyProperty - the foreign key property for which to retrieve the EntityLookupModel
    
    Returns:
    
    the EntityLookupModel associated with the property, if no lookup model has been initialized for the given property, a new one is created, associated with the property and returned.
  - getDefaultValue
```
java.lang.Object getDefaultValue(Property property)
```
    Returns the default value for the given property, used when initializing a new default entity for this edit model. This method is only called for properties that are non-denormalized and are not part of a foreign key. If the default value of a property should be the last value used, call setValuePersistent(String, boolean) with true for the given property or override isValuePersistent(org.jminor.framework.domain.property.Property) so that it returns true for that property in case the value should persist.
    
    Parameters:
    
    property - the property
    
    Returns:
    
    the default value for the property
    
    See Also:
    
    Property.Builder#setDefaultValue(Object), setValuePersistent(String, boolean), isValuePersistent(Property)
  - isValuePersistent
```
boolean isValuePersistent(Property property)
```
    Returns true if the last available value for this property should be used when initializing a default entity. Override for selective reset of field values when the model is cleared. For foreign key property values this method by default returns the value of the property PERSIST_FOREIGN_KEY_VALUES.
    
    Parameters:
    
    property - the property
    
    Returns:
    
    true if the given field value should be reset when the model is cleared
    
    See Also:
    
    PERSIST_FOREIGN_KEY_VALUES
  - isLookupAllowed
```
boolean isLookupAllowed(Property property)
```
    Returns true if values based on this property should be available for lookup via this EditModel. This means displaying all the distinct property values to the user, allowing her to select one.
    
    Parameters:
    
    property - the property
    
    Returns:
    
    true if value lookup should be allowed for this property
  - setValuePersistent
```
EntityEditModel setValuePersistent(java.lang.String propertyId,
                                   boolean persistValueOnClear)
```
    Parameters:
    
    propertyId - the property ID
    
    persistValueOnClear - true if this model should persist the value of the given property on clear
    
    Returns:
    
    this edit model instance
    
    See Also:
    
    PERSIST_FOREIGN_KEY_VALUES
  - insert
```
java.util.List<Entity> insert()
                       throws DatabaseException,
                              ValidationException
```
    Performs a insert on the active entity, sets the primary key values of the active entity according to the primary key of the inserted entity
    
    Returns:
    
    a list containing the inserted entity
    
    Throws:
    
    DatabaseException - in case of a database exception
    
    ValidationException - in case validation fails
    
    See Also:
    
    Entity.Validator.validate(java.util.Collection)
  - insert
```
java.util.List<Entity> insert(java.util.List<Entity> entities)
                       throws DatabaseException,
                              ValidationException
```
    Performs an insert on the given entities, returns silently on receiving an empty list
    
    Parameters:
    
    entities - the entities to insert
    
    Returns:
    
    a list containing the inserted entities
    
    Throws:
    
    DatabaseException - in case of a database exception
    
    ValidationException - in case validation fails
    
    See Also:
    
    addBeforeInsertListener(EventDataListener), addAfterInsertListener(EventDataListener), Entity.Validator.validate(java.util.Collection)
  - update
```
java.util.List<Entity> update()
                       throws DatabaseException,
                              ValidationException
```
    Performs a update on the active entity
    
    Returns:
    
    the updated entities
    
    Throws:
    
    DatabaseException - in case of a database exception
    
    RecordModifiedException - in case an entity was modified by another user
    
    ValidationException - in case validation fails
    
    See Also:
    
    Entity.Validator.validate(java.util.Collection)
  - update
```
java.util.List<Entity> update(java.util.List<Entity> entities)
                       throws DatabaseException,
                              ValidationException
```
    Updates the given entities. If the entities are unmodified or the list is empty this method returns silently.
    
    Parameters:
    
    entities - the entities to update
    
    Returns:
    
    the updated entities
    
    Throws:
    
    DatabaseException - in case of a database exception
    
    RecordModifiedException - in case an entity was modified by another user
    
    ValidationException - in case validation fails
    
    See Also:
    
    addBeforeUpdateListener(EventDataListener), addAfterUpdateListener(EventDataListener), Entity.Validator.validate(java.util.Collection)
  - delete
```
java.util.List<Entity> delete()
                       throws DatabaseException
```
    Deletes the active entity
    
    Returns:
    
    the deleted entities
    
    Throws:
    
    DatabaseException - in case of a database exception
    
    See Also:
    
    addBeforeDeleteListener(EventDataListener), addAfterDeleteListener(EventDataListener)
  - delete
```
java.util.List<Entity> delete(java.util.List<Entity> entities)
                       throws DatabaseException
```
    Deletes the given entities, returns silently on receiving an empty list
    
    Parameters:
    
    entities - the entities to delete
    
    Returns:
    
    the deleted entities
    
    Throws:
    
    DatabaseException - in case of a database exception
    
    See Also:
    
    addBeforeDeleteListener(EventDataListener), addAfterDeleteListener(EventDataListener)
  - isModified
```
boolean isModified()
```
    Returns:
    
    true if the underlying Entity is modified
    
    See Also:
    
    getModifiedObserver()
  - addForeignKeyValues
```
void addForeignKeyValues(java.util.List<Entity> values)
```
    Adds the inserted entities to all foreign key models based on that entity type
    
    Parameters:
    
    values - the values
  - removeForeignKeyValues
```
void removeForeignKeyValues(java.util.List<Entity> values)
```
    Removes the deleted entities from all foreign key models based on that entity type todo set foreign key values referencing the deleted entity to null
    
    Parameters:
    
    values - the values
  - setForeignKeyValues
```
void setForeignKeyValues(java.util.List<Entity> values)
```
    Sets the values in the given list as the values for the respective foreign keys, uses the first value found for each entity type in case of multiple entities of that type
    
    Parameters:
    
    values - the entities
  - getModifiedObserver
```
StateObserver getModifiedObserver()
```
    Returns a StateObserver responsible for indicating when and if any values in the underlying Entity are modified.
    
    Returns:
    
    a StateObserver indicating the modified state of this edit model
    
    See Also:
    
    isModified(), ValueMap.getModifiedObserver()
  - getEntityNewObserver
```
StateObserver getEntityNewObserver()
```
    Returns:
    
    an observer indicating whether or not the active entity is new
    
    See Also:
    
    isEntityNew()
  - getAllowDeleteObserver
```
StateObserver getAllowDeleteObserver()
```
    Returns:
    
    the state used to determine if deleting should be enabled
    
    See Also:
    
    isDeleteAllowed(), setDeleteAllowed(boolean)
  - getPrimaryKeyNullObserver
```
StateObserver getPrimaryKeyNullObserver()
```
    Returns:
    
    a StateObserver indicating whether or not the primary key of the active entity is null
  - getAllowUpdateObserver
```
StateObserver getAllowUpdateObserver()
```
    Returns:
    
    the StateObserver used to determine if updating should be enabled
    
    See Also:
    
    isUpdateAllowed(), setUpdateAllowed(boolean)
  - getAllowInsertObserver
```
StateObserver getAllowInsertObserver()
```
    Returns:
    
    the StateObserver used to determine if inserting should be enabled
    
    See Also:
    
    isInsertAllowed(), setInsertAllowed(boolean)
  - getValueObserver
```
EventObserver<ValueChange<Property,java.lang.Object>> getValueObserver(java.lang.String propertyId)
```
    Parameters:
    
    propertyId - the ID of the property for which to retrieve the event
    
    Returns:
    
    an EventObserver notified when the value of the given property changes
  - addValueSetListener
```
void addValueSetListener(java.lang.String propertyId,
                         EventDataListener<ValueChange<Property,java.lang.Object>> listener)
```
    Adds a listener notified each time the value associated with the given property is set via ValueMapEditModel.put(Object, Object), note that this event is only fired when the the value changes
    
    Parameters:
    
    propertyId - the ID of the property for which to monitor value changes
    
    listener - a listener notified each time the value of the given property is set via this model
  - removeValueSetListener
```
void removeValueSetListener(java.lang.String propertyId,
                            EventDataListener listener)
```
    Parameters:
    
    propertyId - the propertyId
    
    listener - the listener to remove
  - addValueListener
```
void addValueListener(java.lang.String propertyId,
                      EventDataListener<ValueChange<Property,java.lang.Object>> listener)
```
    Adds a listener notified each time the value associated with the given key changes
    
    Parameters:
    
    propertyId - the ID of the property for which to monitor value changes
    
    listener - a listener notified each time the value of the property identified by propertyId changes
  - removeValueListener
```
void removeValueListener(java.lang.String propertyId,
                         EventDataListener listener)
```
    Parameters:
    
    propertyId - the ID of the property for which to remove the listener
    
    listener - the listener to remove
  - addEntitySetListener
```
void addEntitySetListener(EventDataListener<Entity> listener)
```
    Parameters:
    
    listener - a listener notified each time the entity is set
  - removeEntitySetListener
```
void removeEntitySetListener(EventDataListener listener)
```
    Parameters:
    
    listener - the listener to remove
  - addBeforeInsertListener
```
void addBeforeInsertListener(EventDataListener<EntityEditModel.InsertEvent> listener)
```
    Parameters:
    
    listener - a listener to be notified before an insert is performed
  - removeBeforeInsertListener
```
void removeBeforeInsertListener(EventDataListener listener)
```
    Parameters:
    
    listener - a listener to remove
  - addAfterInsertListener
```
void addAfterInsertListener(EventDataListener<EntityEditModel.InsertEvent> listener)
```
    Parameters:
    
    listener - a listener to be notified each time a insert has been performed
  - removeAfterInsertListener
```
void removeAfterInsertListener(EventDataListener listener)
```
    Parameters:
    
    listener - a listener to remove
  - addBeforeUpdateListener
```
void addBeforeUpdateListener(EventDataListener<EntityEditModel.UpdateEvent> listener)
```
    Parameters:
    
    listener - a listener to be notified before an update is performed
  - removeBeforeUpdateListener
```
void removeBeforeUpdateListener(EventDataListener listener)
```
    Parameters:
    
    listener - a listener to remove
  - addAfterUpdateListener
```
void addAfterUpdateListener(EventDataListener<EntityEditModel.UpdateEvent> listener)
```
    Parameters:
    
    listener - a listener to be notified each time an update has been performed
  - removeAfterUpdateListener
```
void removeAfterUpdateListener(EventDataListener listener)
```
    Parameters:
    
    listener - a listener to remove
  - addBeforeDeleteListener
```
void addBeforeDeleteListener(EventDataListener<EntityEditModel.DeleteEvent> listener)
```
    Parameters:
    
    listener - a listener to be notified before a delete is performed
  - removeBeforeDeleteListener
```
void removeBeforeDeleteListener(EventDataListener listener)
```
    Parameters:
    
    listener - a listener to remove
  - addAfterDeleteListener
```
void addAfterDeleteListener(EventDataListener<EntityEditModel.DeleteEvent> listener)
```
    Parameters:
    
    listener - a listener to be notified each time a delete has been performed
  - removeAfterDeleteListener
```
void removeAfterDeleteListener(EventDataListener listener)
```
    Parameters:
    
    listener - a listener to remove
  - addBeforeRefreshListener
```
void addBeforeRefreshListener(EventListener listener)
```
    Parameters:
    
    listener - a listener to be notified before a refresh is performed
  - removeBeforeRefreshListener
```
void removeBeforeRefreshListener(EventListener listener)
```
    Parameters:
    
    listener - a listener to remove
  - addAfterRefreshListener
```
void addAfterRefreshListener(EventListener listener)
```
    Parameters:
    
    listener - a listener to be notified each time a refresh has been performed
  - removeAfterRefreshListener
```
void removeAfterRefreshListener(EventListener listener)
```
    Parameters:
    
    listener - a listener to remove
  - addEntitiesChangedListener
```
void addEntitiesChangedListener(EventListener listener)
```
    Parameters:
    
    listener - a listener to be notified each time a entity is modified via this model, updated, inserted or deleted
  - removeEntitiesChangedListener
```
void removeEntitiesChangedListener(EventListener listener)
```
    Parameters:
    
    listener - a listener to remove
  - addConfirmSetEntityObserver
```
void addConfirmSetEntityObserver(EventDataListener<State> listener)
```
    Parameters:
    
    listener - a listener notified each time the active entity is about to be set
  - removeConfirmSetEntityObserver
```
void removeConfirmSetEntityObserver(EventDataListener listener)
```
    Parameters:
    
    listener - a listener to remove

Interface EntityEditModel

Nested Class Summary

Field Summary

Method Summary

Methods inherited from interface org.jminor.common.model.valuemap.ValueMapEditModel

Methods inherited from interface org.jminor.common.model.Refreshable

Methods inherited from interface org.jminor.framework.model.EntityDataProvider

Field Detail

PERSIST_FOREIGN_KEY_VALUES

WARN_ABOUT_UNSAVED_DATA

COMBO_BOX_NULL_VALUE_ITEM

Method Detail

getDefaultEntity

setEntity

refreshEntity

getEntityCopy

getEntityCopy

isEntityNew

containsUnsavedData

isNull

isNotNull

put

remove

get

getForeignKey

replaceForeignKeyValues

getValueProvider

value

getDomain

getEntityDefinition

isReadOnly

setReadOnly

isWarnAboutUnsavedData

setWarnAboutUnsavedData

isInsertAllowed

setInsertAllowed

isUpdateAllowed

setUpdateAllowed

isDeleteAllowed

setDeleteAllowed

createForeignKeyLookupModel

containsLookupModel

getForeignKeyLookupModel

getForeignKeyLookupModel

getDefaultValue

isValuePersistent

isLookupAllowed

setValuePersistent

insert

insert

update

update

delete

delete

isModified

addForeignKeyValues

removeForeignKeyValues

setForeignKeyValues

getModifiedObserver

getEntityNewObserver

getAllowDeleteObserver

getPrimaryKeyNullObserver

getAllowUpdateObserver

getAllowInsertObserver

getValueObserver

addValueSetListener

removeValueSetListener

addValueListener

removeValueListener

addEntitySetListener

removeEntitySetListener

addBeforeInsertListener

removeBeforeInsertListener

addAfterInsertListener

removeAfterInsertListener

addBeforeUpdateListener

removeBeforeUpdateListener

addAfterUpdateListener

removeAfterUpdateListener

addBeforeDeleteListener