OAProperty (OA Java Code Documentation)

@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`
`String`	`columnName`
`int`	`decimalPlaces`
`String`	`defaultValue`
`String`	`description`
`int`	`displayLength`
`String`	`displayName`
`boolean`	`hasCustomCode`
`boolean`	`hasValidationMethod`
`String`	`help`
`String`	`inputMask`
`String`	`invalidCharacters`
`boolean`	`isAutoSeq`
`boolean`	`isBlob`
`boolean`	`isCaseSensitive`
`boolean`	`isCurrency`
`boolean`	`isEmail`
`boolean`	`isFileName`
`boolean`	`isHtml`
`boolean`	`isIconName`
`boolean`	`isImageName`
`boolean`	`isImportMatch`
`boolean`	`isNameValue`
`boolean`	`isPassword`
`boolean`	`isPhone`
`boolean`	`isProcessed`
`boolean`	`isReadOnly`
`boolean`	`isTimestamp`
`boolean`	`isUnicode`
`boolean`	`isUnique`
`boolean`	`isUrl`
`boolean`	`isXml`
`boolean`	`isZipCode`
`int`	`maxLength`
`int`	`minLength`
`String`	`outputFormat`
`boolean`	`required`
`String`	`toolTip`
`boolean`	`trackPrimitiveNull`
`String`	`validCharacters`
`boolean`	`verify`

Element Detail
- 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

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

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

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

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

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

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

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

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

validCharacters

public abstract String validCharacters

Default:: ""

invalidCharacters

public abstract String invalidCharacters

Default:: ""

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

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

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

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

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

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

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

- isImportMatch
```
public abstract boolean isImportMatch
```
  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

- 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

Annotation Type OAProperty

Optional Element Summary

Element Detail

displayName

description

defaultValue

required

maxLength

minLength

decimalPlaces

displayLength

columnLength

inputMask

outputFormat

verify

validCharacters

invalidCharacters

columnName

toolTip

help

hasCustomCode

isPassword

isReadOnly

isProcessed

isImportMatch

isEmail

isUrl

isImageName

isIconName

isXml

isFileName

isAutoSeq

isTimestamp

isCaseSensitive

isPhone

isZipCode

isHtml

isUnique

isCurrency

hasValidationMethod

isBlob

isNameValue

isUnicode

trackPrimitiveNull