-
- All Known Subinterfaces:
AttributeOptions,EntityOptions
- All Known Implementing Classes:
AttributeOptionsImpl,CommonOptionsImpl,EntityOptionsImpl
public interface CommonOptionsOptions common for attributes and entities.- Author:
- harald
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AccessScopegetAccessScope()The access scope.java.lang.StringgetBindOptions()The bind options.java.lang.StringgetComment()The comment.booleanisAutoSelect()Returns whether autoselect should be turned on.booleanisBindable()Generate bindable annotation.booleanisFromSuper()Declared in super class.booleanisLowerCase()Returns whether lowercase conversion requested.booleanisMapNull()Map null values to constant in database.booleanisMaxCol()Returns true whether the maxcol binding option should be applied.booleanisMute()Element is mute.booleanisNoConstant()No constant strings.booleanisNoDeclare()No declaration code.booleanisNoMethod()No getter and setter methods.booleanisReadOnly()Element is readonly.booleanisTrimRead()Trim on read from database.booleanisTrimWrite()Trim on write to database.booleanisUpperCase()Returns whether uppercase conversion requested.booleanisWriteOnly()Element is writeonly.voidvalidate()Validates the options.
-
-
-
Method Detail
-
getComment
java.lang.String getComment()
The comment.- Returns:
- the comment
-
getBindOptions
java.lang.String getBindOptions()
The bind options.- Returns:
- the bind options
-
isNoDeclare
boolean isNoDeclare()
No declaration code.- Returns:
- true if don't generate declaration
-
isNoMethod
boolean isNoMethod()
No getter and setter methods.- Returns:
- true if don't generate accessor methods
-
isNoConstant
boolean isNoConstant()
No constant strings.- Returns:
- true if don't generate constants for names
-
isMute
boolean isMute()
Element is mute.- Returns:
- true if not part of the pdo
-
isFromSuper
boolean isFromSuper()
Declared in super class.- Returns:
- true if element is derived from the super class
-
isReadOnly
boolean isReadOnly()
Element is readonly.- Returns:
- true if cannot be modified
-
isWriteOnly
boolean isWriteOnly()
Element is writeonly.- Returns:
- true if cannot be read by application
-
getAccessScope
AccessScope getAccessScope()
The access scope.- Returns:
- the scope
-
isTrimRead
boolean isTrimRead()
Trim on read from database.- Returns:
- true if string is trimmed when read
-
isTrimWrite
boolean isTrimWrite()
Trim on write to database.- Returns:
- true if string is trimmed on write
-
isMapNull
boolean isMapNull()
Map null values to constant in database.- Returns:
- true if map null to non-null value
-
isBindable
boolean isBindable()
Generate bindable annotation.- Returns:
- true if bindable element
-
isAutoSelect
boolean isAutoSelect()
Returns whether autoselect should be turned on.- Returns:
- true if autoselect
-
isLowerCase
boolean isLowerCase()
Returns whether lowercase conversion requested.- Returns:
- true if lowercase
-
isMaxCol
boolean isMaxCol()
Returns true whether the maxcol binding option should be applied.- Returns:
- true if maxcol
-
isUpperCase
boolean isUpperCase()
Returns whether uppercase conversion requested.- Returns:
- true if uppercase
-
validate
void validate() throws ModelExceptionValidates the options.- Throws:
ModelException- if validation failed
-
-