org.tentackle.model

Interface AttributeOptions

All Superinterfaces:

CommonOptions

All Known Implementing Classes:

AttributeOptionsImpl

public interface AttributeOptions
extends CommonOptions

Options for attributes.

Author:

harald

Method Summary

Modifier and Type	Method and Description
List<String>	getAnnotations() list of annotations.
Attribute	getAttribute() Gets the attribute this option-set belongs to.
Object	getDefaultValue() Gets the default value if [DEFAULT value] given. The returned type corresponds to the DataType of the Attribute.
boolean	isContextId() Returns whether this is the object id holding the context.
boolean	isDomainKey() Returns whether this is a unique domain key (or part of it).
boolean	isUnsigned() Returns whether this is an unsigned numeric field.
boolean	isUTC() Returns whether this is a UTC timestamp.
boolean	isWithTimezone() Returns whether to use a dedicated timezone. If set, the PDO must provide a method to configure the timezone for the given attribute of the form:

Methods inherited from interface org.tentackle.model.CommonOptions

getAccessScope, getBindOptions, getComment, isAutoSelect, isBind, isDerived, isFromSuper, isLowerCase, isMapNull, isMaxCol, isNoConstant, isNoDeclare, isNoMethod, isReadOnly, isSetGet, isTrimRead, isTrimWrite, isUpperCase, isWriteOnly, validate

Method Detail

getAttribute

Attribute getAttribute()

Gets the attribute this option-set belongs to.

Returns:

the entity

getAnnotations

List<String> getAnnotations()

list of annotations.

Returns:

the annotations

getDefaultValue

Object getDefaultValue()

Gets the default value if [DEFAULT value] given.
The returned type corresponds to the DataType of the Attribute.

Returns:

the defaultValue

isContextId

boolean isContextId()

Returns whether this is the object id holding the context.

Returns:

true if context id

isDomainKey

boolean isDomainKey()

Returns whether this is a unique domain key (or part of it).

Returns:

true if domain key

isUTC

boolean isUTC()

Returns whether this is a UTC timestamp.

Returns:

true if UTC

isWithTimezone

boolean isWithTimezone()

Returns whether to use a dedicated timezone.
If set, the PDO must provide a method to configure the timezone for the given attribute of the form:

 Calendar get<attribute-name>TimezoneConfig();

 Example: Calendar getPrintedTimezoneConfig();
 

Returns:

true if with timezone

isUnsigned

boolean isUnsigned()

Returns whether this is an unsigned numeric field.

Returns:

true if unsigned