PropertyModel

java.lang.Object
- com.incorta.connector.model.PropertyModel

All Implemented Interfaces:

java.io.Serializable
```
public class PropertyModel
extends java.lang.Object
implements java.io.Serializable
```
A property model is used by Incorta to determine how a connector or data set property behaves and how it should appear in the user interface. For example: what UI field type should be used? Is this property required? Does it depend on another property? PropertyModel objects are immutable.

Since:

1.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PropertyModel.Builder` Builder is used for constructing a `PropertyModel` instance.
`static class`	`PropertyModel.PropertyDependency` Represents a property's dependency on another property.
`static class`	`PropertyModel.PropertyValue` Represents a possible property value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PropertyModel.Builder`	`builder()` Creates a new blank `PropertyModel.Builder` object used for constructing a `PropertyModel` instance.
`static PropertyModel.Builder`	`builder(PropertyModel template)` Creates a new `PropertyModel.Builder` object, initialized with the values from the specified `PropertyModel` object.
`java.lang.String`	`getDefaultValue()` Returns the property's default value.
`java.util.List<PropertyModel.PropertyDependency>`	`getDependencies()` Returns a list of property dependencies, which are other properties that this property depends on.
`java.lang.String`	`getDependsOnProperties()` Returns a comma-separated list of property names which, when changed, should trigger this property to be refreshed.
`java.lang.String`	`getExtensions()` Returns the comma-separated list of supported file extensions.
`java.lang.String`	`getExtensionsProperty()` Returns the name of another property, the value of which is a comma separated list of supported file extensions.
`java.lang.String`	`getLabel()` Returns the property label that appears in the UI.
`java.lang.Integer`	`getMaxValue()` Returns the property's maximum value.
`java.lang.Integer`	`getMinValue()` Returns the property's minimum value.
`java.lang.String`	`getName()` Returns the property name.
`java.util.List<PropertyModel.PropertyValue>`	`getPossibleValues()` Returns a list of possible values for this property.
`java.lang.String`	`getPrefix()` Returns the property prefix.
`java.lang.String`	`getSuffix()` Returns the property suffix.
`java.lang.String`	`getTooltip()` Returns the property's tooltip text.
`DisplayType`	`getType()` Returns the type of field that must be displayed in the UI for this property.
`java.lang.String`	`getUsernameProperty()` Returns the name of another property, the value of which is the OAuth username.
`boolean`	`isRequired()` Returns a boolean flag indicating whether this property is required.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getType
```
public final DisplayType getType()
```
    Returns the type of field that must be displayed in the UI for this property.
    
    Returns:
    
    Property display type
    
    Since:
    
    1.0
  - getName
```
public final java.lang.String getName()
```
    Returns the property name. This name does not appear in the UI, but is used to access the property in the Spec object.
    
    Returns:
    
    Property name
    
    Since:
    
    1.0
  - getLabel
```
public final java.lang.String getLabel()
```
    Returns the property label that appears in the UI.
    
    Returns:
    
    Property label
    
    Since:
    
    1.0
  - getPrefix
```
public final java.lang.String getPrefix()
```
    Returns the property prefix. A prefix is an optional text string that appears before the field.
    
    Returns:
    
    Property prefix
    
    Since:
    
    1.0
  - getSuffix
```
public final java.lang.String getSuffix()
```
    Returns the property suffix. A suffix is an optional text string that appears after the field.
    
    Returns:
    
    Property suffix
    
    Since:
    
    1.0
  - getTooltip
```
public final java.lang.String getTooltip()
```
    Returns the property's tooltip text. A tooltip is an icon that appears next to the property and shows a helpful hint when the user hovers over it.
    
    Returns:
    
    Property tooltip
    
    Since:
    
    1.0
  - getDefaultValue
```
public final java.lang.String getDefaultValue()
```
    Returns the property's default value.
    
    Returns:
    
    Default value
    
    Since:
    
    1.0
  - getMinValue
```
public java.lang.Integer getMinValue()
```
    Returns the property's minimum value. This is only valid for numeric properties.
    
    Returns:
    
    Minimum value
    
    Since:
    
    1.0
  - getMaxValue
```
public java.lang.Integer getMaxValue()
```
    Returns the property's maximum value. This is only valid for numeric properties.
    
    Returns:
    
    Maximum value
    
    Since:
    
    1.0
  - getExtensions
```
public final java.lang.String getExtensions()
```
    Returns the comma-separated list of supported file extensions. This is only valid for file upload properties.
    
    Returns:
    
    Comma-separated list of file extensions
    
    Since:
    
    1.0
  - getExtensionsProperty
```
public final java.lang.String getExtensionsProperty()
```
    Returns the name of another property, the value of which is a comma separated list of supported file extensions. This is only valid for file upload properties.
    
    Returns:
    
    Extensions property name
    
    Since:
    
    1.0
  - getUsernameProperty
```
public final java.lang.String getUsernameProperty()
```
    Returns the name of another property, the value of which is the OAuth username. This is only valid for OAUTH properties.
    
    Returns:
    
    Username property
    
    Since:
    
    1.0
  - getDependsOnProperties
```
public final java.lang.String getDependsOnProperties()
```
    Returns a comma-separated list of property names which, when changed, should trigger this property to be refreshed. This is only valid for DYNAMIC_LIST properties.
    
    Returns:
    
    Comma-separated list of property names
    
    Since:
    
    1.0
  - isRequired
```
public final boolean isRequired()
```
    Returns a boolean flag indicating whether this property is required.
    
    Returns:
    
    true if required, false otherwise
    
    Since:
    
    1.0
  - getPossibleValues
```
public final java.util.List<PropertyModel.PropertyValue> getPossibleValues()
```
    Returns a list of possible values for this property. This is only valid for LIST, LIST_WITH_OTHER and DYNAMIC_LIST properties.
    
    Returns:
    
    A list of PropertyModel.PropertyValue objects
    
    Since:
    
    1.0
  - getDependencies
```
public final java.util.List<PropertyModel.PropertyDependency> getDependencies()
```
    Returns a list of property dependencies, which are other properties that this property depends on.
    
    Returns:
    
    A list of PropertyModel.PropertyDependency objects
    
    Since:
    
    1.0
  - builder
```
public static PropertyModel.Builder builder()
```
    Creates a new blank PropertyModel.Builder object used for constructing a PropertyModel instance.
    
    Returns:
    
    New PropertyModel.Builder object
    
    Since:
    
    1.0
  - builder
```
public static PropertyModel.Builder builder(PropertyModel template)
```
    Creates a new PropertyModel.Builder object, initialized with the values from the specified PropertyModel object.
    
    Parameters:
    
    template - PropertyModel instance used for initializing this builder
    
    Returns:
    
    New PropertyModel.Builder object
    
    Since:
    
    1.0

Class PropertyModel

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getType

getName

getLabel

getPrefix

getSuffix

getTooltip

getDefaultValue

getMinValue

getMaxValue

getExtensions

getExtensionsProperty

getUsernameProperty

getDependsOnProperties

isRequired

getPossibleValues

getDependencies

builder

builder