com.cafesoft.core.field
Interface FieldInfo

All Known Implementing Classes:

AbstractFieldInfo, IntegerFieldInfo, StringFieldInfo

public interface FieldInfo

Defines the interface to a container for Field metadata.

Since:

7/18/03

Method Summary

boolean	allowNull() Get the null value status.
Object	getDefaultValue() Get the default field value.
FieldType	getFieldType() Get the FieldType.
FieldValidationRule	getFieldValidationRule() Get the FieldValidationRule.
FieldValueOptions	getFieldValueOptions() Get the FieldValueOptions object.
String	getName() Get the field name.
boolean	isRequired() Get the required status.
void	setFieldValidationRule(FieldValidationRule rule) Set the FieldValidationRule.
void	setFieldValueOptions(FieldValueOptions options) Set the FieldValueOptions object.

Method Detail

getFieldType

FieldType getFieldType()

Get the FieldType.

Returns:

the FieldType.

getName

String getName()

Get the field name.

Returns:

the field name.

isRequired

boolean isRequired()

Get the required status.

Returns:

the true if the field is required, else false.

allowNull

boolean allowNull()

Get the null value status.

Returns:

the true if the field is allowed to be null, false otherwise.

getFieldValidationRule

FieldValidationRule getFieldValidationRule()

Get the FieldValidationRule.

Returns:

the FieldValidationRule.

setFieldValidationRule

void setFieldValidationRule(FieldValidationRule rule)

Set the FieldValidationRule.

Parameters:

rule - the new FieldValidationRule.

getFieldValueOptions

FieldValueOptions getFieldValueOptions()

Get the FieldValueOptions object.

Returns:

the FieldValueOptions object, or null if one does not exist.

setFieldValueOptions

void setFieldValueOptions(FieldValueOptions options)

Set the FieldValueOptions object.

Parameters:

options - the new FieldValueOptions object.

getDefaultValue

Object getDefaultValue()

Get the default field value.

Returns:

the default field value.