-
- All Superinterfaces:
CommonOptions
- All Known Implementing Classes:
AttributeOptionsImpl
public interface AttributeOptions extends CommonOptions
Options for attributes.- Author:
- harald
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.List<java.lang.String>getAnnotations()list of annotations.AttributegetAttribute()Gets the attribute this option-set belongs to.java.lang.ObjectgetDefaultValue()Gets the default value if [DEFAULT value] given.
The returned type corresponds to the DataType of the Attribute.java.lang.StringgetInitialValue()Gets the initial value if [INIT value] given.booleanisContextId()Returns whether this is the object id holding the context.booleanisDomainKey()Returns whether this is a unique domain key (or part of it).booleanisHidden()Returns whether the attribute is not declared in the interface.booleanisShallow()Returns whether the attribute should be skipped in snapshot and copy operations.booleanisUnsigned()Returns whether this is an unsigned numeric field.booleanisUTC()Returns whether this is a UTC timestamp.booleanisWithTimezone()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
java.util.List<java.lang.String> getAnnotations()
list of annotations.- Returns:
- the annotations
-
getDefaultValue
java.lang.Object getDefaultValue()
Gets the default value if [DEFAULT value] given.
The returned type corresponds to the DataType of the Attribute.- Returns:
- the defaultValue
-
getInitialValue
java.lang.String getInitialValue()
Gets the initial value if [INIT value] given.- Returns:
- the string to initialize the declaration with
-
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
-
isHidden
boolean isHidden()
Returns whether the attribute is not declared in the interface.- Returns:
- true if implemented only, no public interface definition
-
isShallow
boolean isShallow()
Returns whether the attribute should be skipped in snapshot and copy operations.- Returns:
- true if skip this attribute, false to include (default)
-
-