- All Known Subinterfaces:
AttributeOptions,EntityOptions
- All Known Implementing Classes:
AttributeOptionsImpl,CommonOptionsImpl,EntityOptionsImpl
public interface CommonOptions
Options common for attributes and entities.
- Author:
- harald
-
Method Summary
Modifier and TypeMethodDescriptionThe access scope.The bind options.The comment.Gets the list of custom stereotypes.booleanReturns whether autoselect should be turned on.booleanGenerate bindable annotation.booleanDeclared in super class.booleanReturns whether lowercase conversion requested.booleanMap null values to constant in database.booleanisMaxCol()Returns true whether the maxcol binding option should be applied.booleanisMute()Element is mute.booleanNo constant strings.booleanNo declaration code.booleanNo getter and setter methods.booleanElement is read-only.booleanTrim on read from database.booleanTrim on write to database.booleanReturns whether uppercase conversion requested.booleanElement is write-only.voidvalidate()Validates the options.
-
Method Details
-
getComment
String getComment()The comment.- Returns:
- the comment
-
getStereotypes
Gets the list of custom stereotypes.- Returns:
- the stereotypes
-
getBindOptions
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 no accessor methods must be generated
-
isNoConstant
boolean isNoConstant()No constant strings.- Returns:
- true if no name constants must be generated
-
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 read-only.- Returns:
- true if element cannot be modified
-
isWriteOnly
boolean isWriteOnly()Element is write-only.- Returns:
- true if element 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
Validates the options.- Throws:
ModelException- if validation failed
-