Module is.codion.framework.model

Package is.codion.framework.model

Interface EntityEditModel.EditableEntity

All Superinterfaces:

Mutable<Entity>, Observable<Entity>, Observer<Entity>

Enclosing interface:

EntityEditModel

public static interface EntityEditModel.EditableEntity
extends Mutable<Entity>

Provides access to the active entity being edited.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EntityEditModel.EditableEntity.Exists	Indicates whether the active entity exists in the database.
static interface	EntityEditModel.EditableEntity.Modified	Indicates whether the active entity is modified.

Method Summary

Modifier and Type	Method	Description
Observer<Entity>	changing()
void	clear()	Clears all values from the underlying entity, disregarding the EntityEditModel.EditableValue.persist() directive.
void	defaults()	Populates this edit model with default values for all attributes.
StateObserver	edited()
EntityEditModel.EditableEntity.Exists	exists()
StateObserver	isNotNull(Attribute<?> attribute)
StateObserver	isNull(Attribute<?> attribute)
EntityEditModel.EditableEntity.Modified	modified()	Returns a StateObserver indicating whether any values have been modified.
boolean	nullable(Attribute<?> attribute)
StateObserver	primaryKeyNull()
void	refresh()	Refreshes the active Entity from the database, discarding all changes.
void	revert()	Reverts all attribute value changes.
void	set(Entity entity)	Sets the given entity or defaults if null.
StateObserver	valid()
void	validate()	Validates the current state of the entity
Value<EntityValidator>	validator()	Controls the validator used by this edit model.
<T> EntityEditModel.EditableValue<T>	value(Attribute<T> attribute)	Returns the EntityEditModel.EditableValue instance representing attribute in this EntityEditModel.EditableEntity.
Observer<Attribute<?>>	valueChanged()	Returns an observer notified each time a value changes, either via its associated EntityEditModel.EditableValue instance or when the entity is set via Mutable.set(Object) or defaults().

Methods inherited from interface is.codion.common.observer.Observable

addConsumer, addListener, addWeakConsumer, addWeakListener, get, observer, optional, removeConsumer, removeListener, removeWeakConsumer, removeWeakListener

Method Details

set

void set(Entity entity)

Sets the given entity or defaults if null. Use clear() in order to clear the entity of all values.

Specified by:

set in interface Mutable<Entity>

Parameters:

entity - the entity to set, if null, then defaults are set

clear

void clear()

Clears all values from the underlying entity, disregarding the EntityEditModel.EditableValue.persist() directive.

Specified by:

clear in interface Mutable<Entity>

defaults

void defaults()

Populates this edit model with default values for all attributes.

See Also:

• EntityEditModel.EditableValue.defaultValue()
• EntityEditModel.EditableValue.persist()
• AttributeDefinition.defaultValue()

refresh

void refresh()

Refreshes the active Entity from the database, discarding all changes. If the active Entity is new then calling this method has no effect.

revert

void revert()

Reverts all attribute value changes.

exists

EntityEditModel.EditableEntity.Exists exists()

Returns:

a StateObserver indicating whether the entity exists in the database

See Also:

• EntityEditModel.EditableEntity.Exists.predicate()

modified

EntityEditModel.EditableEntity.Modified modified()

Returns a StateObserver indicating whether any values have been modified.

Returns:

a StateObserver indicating the modified state of this entity

See Also:

• EntityEditModel.EditableEntity.Modified.predicate()

edited

StateObserver edited()

Returns:

a StateObserver indicating whether the entity has been edited, that is, exists and is modified

See Also:

• modified()
• exists()

changing

Observer<Entity> changing()

Returns:

an observer notified each time the entity is about to be changed via Mutable.set(Object) or defaults()

See Also:

• Mutable.set(Object)
• defaults()

valueChanged

Observer<Attribute<?>> valueChanged()

Returns an observer notified each time a value changes, either via its associated EntityEditModel.EditableValue instance or when the entity is set via Mutable.set(Object) or defaults().

Returns:

an observer notified each time a value changes

isNull

StateObserver isNull(Attribute<?> attribute)

Parameters:

attribute - the attribute

Returns:

a StateObserver indicating whether the value of the given attribute is null

isNotNull

StateObserver isNotNull(Attribute<?> attribute)

Parameters:

attribute - the attribute

Returns:

a StateObserver indicating whether the value of the given attribute is not null

primaryKeyNull

StateObserver primaryKeyNull()

Returns:

a StateObserver indicating whether the primary key of the entity is null

valid

StateObserver valid()

Returns:

a StateObserver indicating the valid status of the underlying Entity.

See Also:

• EntityEditModel.validate(Attribute)
• EntityValidator.validate(Entity)

validator

Value<EntityValidator> validator()

Controls the validator used by this edit model.

Returns:

the Value controlling the validator

See Also:

• EntityEditModel.validate(Entity)

validate

void validate()
       throws ValidationException

Validates the current state of the entity

Throws:

ValidationException - in case the entity is invalid

nullable

boolean nullable(Attribute<?> attribute)

Parameters:

attribute - the attribute

Returns:

true if this value is allowed to be null according to the validator

See Also:

• validator()

value

<T> EntityEditModel.EditableValue<T> value(Attribute<T> attribute)

Returns the EntityEditModel.EditableValue instance representing attribute in this EntityEditModel.EditableEntity.

Type Parameters:

T - the value type

Parameters:

attribute - the attribute

Returns:

the EntityEditModel.EditableValue representing the given attribute