com.qcadoo.model.api

Interface FieldDefinition

public interface FieldDefinition

Object defines database field.

Since:

0.4.0

Method Summary

Modifier and Type	Method and Description
DataDefinition	getDataDefinition() Return data definition which this field belongs to.
Object	getDefaultValue() Return default value for this field.
String	getExpression() Get expression to get the field value.
String	getName() Return field's name.
FieldType	getType() Return field's type.
String	getValue(Object value, Locale locale) Convert value to string.
boolean	isPersistent() Return true if this field is persistent (will be saved in database).
boolean	isReadOnly() Return true if this field is readonly.
boolean	isRequired() Return true if this field is required.
boolean	isUnique() Return true if this field is unique.

Method Detail

getDataDefinition

DataDefinition getDataDefinition()

Return data definition which this field belongs to.

Returns:

data definition

getDefaultValue

Object getDefaultValue()

Return default value for this field.

Returns:

default value

getExpression

String getExpression()

Get expression to get the field value.

Returns:

expression

getName

String getName()

Return field's name.

Returns:

field's name

getType

FieldType getType()

Return field's type.

Returns:

field's type

getValue

String getValue(Object value,
                Locale locale)

Convert value to string.

Parameters:

value - value

locale - locale

Returns:

string or null

See Also:

FieldType.toString(Object, Locale)

isPersistent

boolean isPersistent()

Return true if this field is persistent (will be saved in database).

Returns:

is persistent

isReadOnly

boolean isReadOnly()

Return true if this field is readonly.

Returns:

is readonly

isRequired

boolean isRequired()

Return true if this field is required.

Returns:

is required

isUnique

boolean isUnique()

Return true if this field is unique.

Returns:

is unique