OAProperty (com.viaoa:oa-core 3.7.12 API)

@Documented
 @Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface OAProperty

Defines the properties in an OAObject class.

Author:: vvia

Optional Element Summary

Optional Elements
Modifier and Type	Optional Element and Description
`int`	`columnLength` Deprecated.
`String`	`columnName` Deprecated.
`int`	`decimalPlaces`
`String`	`defaultValue`
`String`	`description`
`int`	`displayLength`
`String`	`displayName`
`String`	`enumPropertyName`
`String`	`format`
`boolean`	`hasCustomCode`
`boolean`	`hasValidationMethod`
`String`	`help`
`boolean`	`ignoreTimeZone` If true, then datetimes dont need timezone
`boolean`	`importMatch`
`String`	`invalidCharacters`
`boolean`	`isAutoSeq`
`boolean`	`isBlob`
`boolean`	`isCaseSensitive`
`boolean`	`isCurrency`
`boolean`	`isEmail`
`boolean`	`isEncrypted`
`boolean`	`isFileName`
`boolean`	`isFkeyOnly`
`boolean`	`isHtml`
`boolean`	`isIconName`
`boolean`	`isImageName`
`boolean`	`isJson`
`boolean`	`isLower`
`boolean`	`isNameValue`
`boolean`	`isPassword` Deprecated.
`boolean`	`isPhone`
`boolean`	`isProcessed`
`boolean`	`isReadOnly`
`boolean`	`isSHAHash`
`boolean`	`isSubmit` Flag used to determine if the object is completed and ready for submitted.
`boolean`	`isTimestamp`
`boolean`	`isUnicode`
`boolean`	`isUnique`
`boolean`	`isUpper`
`boolean`	`isUrl`
`boolean`	`isXml`
`boolean`	`isZipCode`
`String`	`lowerName`
`int`	`maxLength`
`int`	`minLength`
`boolean`	`noPojo` Flag to know if this property is used in POJO.
`int`	`pojoKeyPos` If greater then 0 (1 based), this is a pkey (1+) property for the POJO.
`boolean`	`required`
`boolean`	`sensitiveData`
`String`	`timeZonePropertyPath`
`String`	`toolTip`
`boolean`	`trackPrimitiveNull`
`int`	`uiColumnLength`
`String`	`uiColumnName` name to use for Grid/Table column heading
`String`	`validCharacters`
`boolean`	`verify`

Element Detail
- lowerName
```
public abstract String lowerName
```
  Default:
  
  ""

- displayName
```
public abstract String displayName
```
  Default:
  
  ""

- description
```
public abstract String description
```
  Default:
  
  ""

- defaultValue
```
public abstract String defaultValue
```
  Default:
  
  ""

- required
```
public abstract boolean required
```
  Default:
  
  false

- decimalPlaces
```
public abstract int decimalPlaces
```
  Default:
  
  -1

- displayLength
```
public abstract int displayLength
```
  Default:
  
  0

- minLength
```
public abstract int minLength
```
  Default:
  
  0

- maxLength
```
public abstract int maxLength
```
  Default:
  
  0

- uiColumnName
```
public abstract String uiColumnName
```
  name to use for Grid/Table column heading
  
  Default:
  
  ""

columnName

@Deprecated
public abstract String columnName

Deprecated.

Default:: ""

- uiColumnLength
```
public abstract int uiColumnLength
```
  Returns:
  
  length of the column in a table/grid UI component.
  
  Default:
  
  0

columnLength

@Deprecated
public abstract int columnLength

Deprecated.

Default:: 0

- format
```
public abstract String format
```
  Default:
  
  ""

- verify
```
public abstract boolean verify
```
  Default:
  
  false

validCharacters

public abstract String validCharacters

Default:: ""

invalidCharacters

public abstract String invalidCharacters

Default:: ""

- toolTip
```
public abstract String toolTip
```
  Returns:
  
  column name used for table/grid UI component
  
  Default:
  
  ""

- help
```
public abstract String help
```
  Default:
  
  ""

- hasCustomCode
```
public abstract boolean hasCustomCode
```
  Default:
  
  false

- isEncrypted
```
public abstract boolean isEncrypted
```
  Default:
  
  false

- isPassword
```
@Deprecated
public abstract boolean isPassword
```
  Deprecated.
  
  use isSHAHash or isEncrypted instead
  
  Returns:
  
  Default:
  
  false

- isSHAHash
```
public abstract boolean isSHAHash
```
  Default:
  
  false

- isReadOnly
```
public abstract boolean isReadOnly
```
  Default:
  
  false

- isProcessed
```
public abstract boolean isProcessed
```
  Default:
  
  false

- isEmail
```
public abstract boolean isEmail
```
  Default:
  
  false

- isUrl
```
public abstract boolean isUrl
```
  Default:
  
  false

- isImageName
```
public abstract boolean isImageName
```
  Default:
  
  false

- isIconName
```
public abstract boolean isIconName
```
  Default:
  
  false

- isXml
```
public abstract boolean isXml
```
  Default:
  
  false

- isFileName
```
public abstract boolean isFileName
```
  Default:
  
  false

- isAutoSeq
```
public abstract boolean isAutoSeq
```
  Default:
  
  false

- isTimestamp
```
public abstract boolean isTimestamp
```
  Default:
  
  false

isCaseSensitive

public abstract boolean isCaseSensitive

Default:: false

- isPhone
```
public abstract boolean isPhone
```
  Default:
  
  false

- isZipCode
```
public abstract boolean isZipCode
```
  Default:
  
  false

- isHtml
```
public abstract boolean isHtml
```
  Default:
  
  false

- isJson
```
public abstract boolean isJson
```
  Default:
  
  false

- isUnique
```
public abstract boolean isUnique
```
  Returns:
  
  if true, then the property value must be unique.
  
  Default:
  
  false

- isCurrency
```
public abstract boolean isCurrency
```
  Default:
  
  false

- hasValidationMethod
```
public abstract boolean hasValidationMethod
```
  Returns:
  
  will be used to know if there is a validation method (not yet used at this time)
  
  Default:
  
  false

- isBlob
```
public abstract boolean isBlob
```
  Default:
  
  false

- isNameValue
```
public abstract boolean isNameValue
```
  Default:
  
  false

- isUnicode
```
public abstract boolean isUnicode
```
  Default:
  
  false

trackPrimitiveNull

public abstract boolean trackPrimitiveNull

Default:: true

- ignoreTimeZone
```
public abstract boolean ignoreTimeZone
```
  If true, then datetimes dont need timezone
  
  Default:
  
  false

- isSubmit
```
public abstract boolean isSubmit
```
  Flag used to determine if the object is completed and ready for submitted.
  
  Default:
  
  false

timeZonePropertyPath

public abstract String timeZonePropertyPath

Default:: ""

- isUpper
```
public abstract boolean isUpper
```
  Default:
  
  false

- isLower
```
public abstract boolean isLower
```
  Default:
  
  false

- sensitiveData
```
public abstract boolean sensitiveData
```
  Default:
  
  false

- importMatch
```
public abstract boolean importMatch
```
  Default:
  
  false

enumPropertyName

public abstract String enumPropertyName

Default:: ""

- isFkeyOnly
```
public abstract boolean isFkeyOnly
```
  Default:
  
  false

- noPojo
```
public abstract boolean noPojo
```
  Flag to know if this property is used in POJO.
  
  Default:
  
  false

- pojoKeyPos
```
public abstract int pojoKeyPos
```
  If greater then 0 (1 based), this is a pkey (1+) property for the POJO.
  
  Default:
  
  0

Annotation Type OAProperty

Optional Element Summary

Element Detail

lowerName

displayName

description

defaultValue

required

decimalPlaces

displayLength

minLength

maxLength

uiColumnName

columnName

uiColumnLength

columnLength

format

verify

validCharacters

invalidCharacters

toolTip

help

hasCustomCode

isEncrypted

isPassword

isSHAHash

isReadOnly

isProcessed

isEmail

isUrl

isImageName

isIconName

isXml

isFileName

isAutoSeq

isTimestamp

isCaseSensitive

isPhone

isZipCode

isHtml

isJson

isUnique

isCurrency

hasValidationMethod

isBlob

isNameValue

isUnicode

trackPrimitiveNull

ignoreTimeZone

isSubmit

timeZonePropertyPath

isUpper

isLower

sensitiveData

importMatch

enumPropertyName

isFkeyOnly

noPojo

pojoKeyPos