com.qcadoo.model.api

Interface Entity

All Superinterfaces:

EntityMessagesHolder

All Known Subinterfaces:

EntityTreeNode

public interface Entity
extends EntityMessagesHolder

Object represents data from the database tables. All fields are aggregated into key-value map. The key is the name of the field from its definition - FieldDefinition.getName().

Since:

0.4.0

Method Summary

Modifier and Type	Method and Description
Entity	copy() Create new entity and copy fields values.
Entity	getBelongsToField(String fieldName) Return the value, casted to entity, of the field with given name.
boolean	getBooleanField(String fieldName) Return the boolean value of the field with given name
DataDefinition	getDataDefinition() Return the entity's dataDefinition.
Date	getDateField(String fieldName) Return the Date value of the field with given name
BigDecimal	getDecimalField(String fieldName) Return the decimal (java.math.BigDecimal) value of the field with given name
Object	getField(String fieldName) Return the value of the field with given name.
Map<String,Object>	getFields() Return all field's values.
EntityList	getHasManyField(String fieldName) Return the value, casted to list of entities, of the field with given name.
Long	getId() Return the entity's id.
Integer	getIntegerField(String fieldName) Return the Integer value of the field with given name
Long	getLongField(String fieldName) Return the Long value of the field with given name
List<Entity>	getManyToManyField(String fieldName) Return the value, casted to list of entities, of the field with given name.
String	getStringField(String fieldName) Return the value, casted to string, of the field with given name.
EntityTree	getTreeField(String fieldName) Return the value, casted to tree, of the field with given name.
boolean	isActive() Returns true if entity is active.
boolean	isCopied()
boolean	isFieldValid(String fieldName) Return true if there is no field's errors for given field.
boolean	isValid() Return true if there is no global and field's errors.
void	setActive(boolean active) Set if entity is active.
void	setCopied(boolean copied)
void	setField(String fieldName, Object fieldValue) Set the value of the field with given name.
void	setId(Long id) Set the entity's id.
void	setNotValid() Set validation status as not valid

Methods inherited from interface com.qcadoo.model.api.EntityMessagesHolder

addError, addGlobalError, addGlobalError, addGlobalError, addGlobalMessage, addGlobalMessage, getError, getErrors, getGlobalErrors, getGlobalMessages

Method Detail

copy

Entity copy()

Create new entity and copy fields values. Notice: This method copies all the fields of entity, including the ID and fields with copyable attribute set to false. Returned copy is not persisted. If you want to make persistent copy with unique ID and copyable/persistent/etc. attributes aware consider use DataDefinition.copy(Long...)

Returns:

copied entity

getBelongsToField

Entity getBelongsToField(String fieldName)

Return the value, casted to entity, of the field with given name.

Parameters:

fieldName - field's name

Returns:

the field's value

Throws:

IllegalArgumentException - if given field is not belongsTo type

getBooleanField

boolean getBooleanField(String fieldName)

Return the boolean value of the field with given name

Parameters:

fieldName - field's name

Returns:

the field's boolean value

getDataDefinition

DataDefinition getDataDefinition()

Return the entity's dataDefinition.

Returns:

the entity's dataDefinition

getDateField

Date getDateField(String fieldName)

Return the Date value of the field with given name

Parameters:

fieldName - field's name

Returns:

the field's date value, when it's empty null is returned (not 0)

Throws:

IllegalArgumentException

getDecimalField

BigDecimal getDecimalField(String fieldName)

Return the decimal (java.math.BigDecimal) value of the field with given name

Parameters:

fieldName - field's name

Returns:

the field's decimal value

Throws:

IllegalArgumentException - if given field is not BigDecimal (sub)type

getField

Object getField(String fieldName)

Return the value of the field with given name.

Parameters:

fieldName - field's name

Returns:

the field's value

getFields

Map<String,Object> getFields()

Return all field's values.

Returns:

field's values - name - value pairs

getHasManyField

EntityList getHasManyField(String fieldName)

Return the value, casted to list of entities, of the field with given name.

Parameters:

fieldName - field's name

Returns:

the field's value

Throws:

IllegalArgumentException - if given field have incompatible type

getId

Long getId()

Return the entity's id.

Returns:

the entity's id

getIntegerField

Integer getIntegerField(String fieldName)

Return the Integer value of the field with given name

Parameters:

fieldName - field's name

Returns:

the field's integer value, when it's empty null is returned (not 0)

Throws:

IllegalArgumentException - if given field is not Integer type

getLongField

Long getLongField(String fieldName)

Return the Long value of the field with given name

Parameters:

fieldName - field's name

Returns:

the field's long value, when it's empty null is returned (not 0)

Throws:

IllegalArgumentException - if given field is not Integer type

getManyToManyField

List<Entity> getManyToManyField(String fieldName)

Return the value, casted to list of entities, of the field with given name.

Parameters:

fieldName - field's name

Returns:

the field's value

getStringField

String getStringField(String fieldName)

Return the value, casted to string, of the field with given name.

Parameters:

fieldName - field's name

Returns:

the field's value

getTreeField

EntityTree getTreeField(String fieldName)

Return the value, casted to tree, of the field with given name.

Parameters:

fieldName - field's name

Returns:

the field's value

isActive

boolean isActive()

Returns true if entity is active.

Returns:

true if active

Since:

0.4.2

isCopied

boolean isCopied()

isFieldValid

boolean isFieldValid(String fieldName)

Return true if there is no field's errors for given field.

Parameters:

fieldName - field's name

Returns:

true if field is valid

isValid

boolean isValid()

Return true if there is no global and field's errors.

Returns:

true if entity is valid

setActive

void setActive(boolean active)

Set if entity is active.

Parameters:

active - is active

Since:

0.4.2

setCopied

void setCopied(boolean copied)

setField

void setField(String fieldName,
              Object fieldValue)

Set the value of the field with given name.

Parameters:

fieldName - field's name

fieldValue - field'value

setId

void setId(Long id)

Set the entity's id.

Parameters:

id - the entity's name

setNotValid

void setNotValid()

Set validation status as not valid