InputParameter (CUBA 7.2 API)

java.lang.Object
- com.haulmont.cuba.gui.app.core.inputdialog.InputParameter

public class InputParameter
extends java.lang.Object

Describes field that can be used in InputDialog.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`caption`
`protected Datatype`	`datatype`
`protected java.lang.Class`	`datatypeJavaClass`
`protected java.lang.Object`	`defaultValue`
`protected java.lang.Class<? extends Entity>`	`entityClass`
`protected java.lang.Class<? extends EnumClass>`	`enumClass`
`protected java.util.function.Supplier<Field>`	`field`
`protected java.lang.String`	`id`
`protected boolean`	`required`

Constructor Summary

Constructors
Constructor and Description

InputParameter(java.lang.String id)

Constructors
Constructor and Description
`InputParameter(java.lang.String id)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static InputParameter`	`bigDecimalParameter(java.lang.String id)` Creates parameter with BigDecimal type.
`static InputParameter`	`booleanParameter(java.lang.String id)` Creates parameter with Boolean type.
`protected void`	`checkNullDatatype(java.lang.String message)`
`protected void`	`checkNullDatatypeJavaClass(java.lang.String message)`
`protected void`	`checkNullEntityClass(java.lang.String message)`
`protected void`	`checkNullEnumClass(java.lang.String message)`
`static InputParameter`	`dateParameter(java.lang.String id)` Creates parameter with Date type.
`static InputParameter`	`dateTimeParameter(java.lang.String id)` Creates parameter with DateTime type.
`static InputParameter`	`doubleParameter(java.lang.String id)` Creates parameter with Double type.
`static InputParameter`	`entityParameter(java.lang.String id, java.lang.Class<? extends Entity> entityClass)` Creates parameter with Entity type.
`static InputParameter`	`enumParameter(java.lang.String id, java.lang.Class<? extends EnumClass> enumClass)` Creates parameter with Enum type.
`boolean`	`equals(java.lang.Object obj)`
`static InputParameter`	`fileParameter(java.lang.String id)` Creates parameter with FileDescriptor type.
`java.lang.String`	`getCaption()`
`Datatype`	`getDatatype()`
`protected java.lang.Class`	`getDatatypeJavaClass()`
`java.lang.Object`	`getDefaultValue()`
`java.lang.Class<? extends Entity>`	`getEntityClass()`
`java.lang.Class<? extends EnumClass>`	`getEnumClass()`
`java.util.function.Supplier<Field>`	`getField()`
`java.lang.String`	`getId()`
`int`	`hashCode()`
`static InputParameter`	`intParameter(java.lang.String id)` Creates parameter with Integer type.
`boolean`	`isRequired()`
`static InputParameter`	`localDateParameter(java.lang.String id)` Creates parameter with LocalDate type.
`static InputParameter`	`localDateTimeParameter(java.lang.String id)` Creates parameter with LocalDateTime type.
`static InputParameter`	`localTimeParameter(java.lang.String id)` Creates parameter with LocalTime type.
`static InputParameter`	`longParameter(java.lang.String id)` Creates parameter with Long type.
`static InputParameter`	`offsetDateTimeParameter(java.lang.String id)` Creates parameter with OffsetDateTime type.
`static InputParameter`	`offsetTimeParameter(java.lang.String id)` Creates parameter with OffsetTime type.
`static InputParameter`	`parameter(java.lang.String id)` Creates parameter with String type.
`static InputParameter`	`stringParameter(java.lang.String id)` Creates parameter with String type.
`static InputParameter`	`timeParameter(java.lang.String id)` Creates parameter with Time type.
`InputParameter`	`withCaption(java.lang.String caption)` Sets caption to the field.
`InputParameter`	`withDatatype(Datatype datatype)` Sets datatype to the field.
`protected InputParameter`	`withDatatypeJavaClass(java.lang.Class javaClass)`
`InputParameter`	`withDefaultValue(java.lang.Object defaultValue)` Sets default value to the field.
`InputParameter`	`withEntityClass(java.lang.Class<? extends Entity> entityClass)` Sets entity class.
`InputParameter`	`withEnumClass(java.lang.Class<? extends EnumClass> enumClass)` Sets enum class.
`InputParameter`	`withField(java.util.function.Supplier<Field> field)` Sets field supplier.
`InputParameter`	`withId(java.lang.String id)` Sets field id.
`InputParameter`	`withRequired(boolean required)` Sets required for the field.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - id
```
protected java.lang.String id
```
  - caption
```
protected java.lang.String caption
```
  - required
```
protected boolean required
```
  - datatype
```
protected Datatype datatype
```
  - field
```
protected java.util.function.Supplier<Field> field
```
  - defaultValue
```
protected java.lang.Object defaultValue
```
  - entityClass
```
protected java.lang.Class<? extends Entity> entityClass
```
  - enumClass
```
protected java.lang.Class<? extends EnumClass> enumClass
```
  - datatypeJavaClass
```
protected java.lang.Class datatypeJavaClass
```
- Constructor Detail
  - InputParameter
```
public InputParameter(java.lang.String id)
```
    Parameters:
    
    id - field id
- Method Detail
  - getId
```
public java.lang.String getId()
```
    Returns:
    
    field id
  - withId
```
public InputParameter withId(java.lang.String id)
```
    Sets field id.
    
    Parameters:
    
    id - field id
    
    Returns:
    
    input parameter
  - getCaption
```
public java.lang.String getCaption()
```
    Returns:
    
    field caption
  - withCaption
```
public InputParameter withCaption(java.lang.String caption)
```
    Sets caption to the field.
    
    Parameters:
    
    caption - caption
    
    Returns:
    
    input parameter
  - isRequired
```
public boolean isRequired()
```
    Returns:
    
    true if field is required
  - withRequired
```
public InputParameter withRequired(boolean required)
```
    Sets required for the field.
    
    Parameters:
    
    required - required option
    
    Returns:
    
    input parameter
  - getDatatype
```
public Datatype getDatatype()
```
    Returns:
    
    field Datatype
  - withDatatype
```
public InputParameter withDatatype(Datatype datatype)
```
    Sets datatype to the field. Cannot be used with withEntityClass(Class), withEnumClass(Class) and with predefined static methods.
    Note, it doesn't support custom Datatype. Use withField(Supplier).
    
    Parameters:
    
    datatype - datatype
    
    Returns:
    
    input parameter
  - withDatatypeJavaClass
```
protected InputParameter withDatatypeJavaClass(java.lang.Class javaClass)
```
  - getDatatypeJavaClass
```
protected java.lang.Class getDatatypeJavaClass()
```
  - getField
```
public java.util.function.Supplier<Field> getField()
```
    Returns:
    
    field supplier
  - withField
```
public InputParameter withField(java.util.function.Supplier<Field> field)
```
    Sets field supplier.
    Note, in order to get value from this field you must use an id that is set to the InputParameter, not to the created field.
    
    Parameters:
    
    field - supplier
    
    Returns:
    
    input parameter
  - getDefaultValue
```
public java.lang.Object getDefaultValue()
```
    Returns:
    
    default value
  - withDefaultValue
```
public InputParameter withDefaultValue(java.lang.Object defaultValue)
```
    Sets default value to the field.
    
    Parameters:
    
    defaultValue - default value
    
    Returns:
    
    input parameter
  - getEntityClass
```
public java.lang.Class<? extends Entity> getEntityClass()
```
    Returns:
    
    entity class
  - withEntityClass
```
public InputParameter withEntityClass(java.lang.Class<? extends Entity> entityClass)
```
    Sets entity class. Cannot be used with withDatatype(Datatype), withEnumClass(Class) and with predefined static methods.
    
    Parameters:
    
    entityClass - entity class
    
    Returns:
    
    input parameter
  - getEnumClass
```
public java.lang.Class<? extends EnumClass> getEnumClass()
```
    Returns:
    
    enum class
  - withEnumClass
```
public InputParameter withEnumClass(java.lang.Class<? extends EnumClass> enumClass)
```
    Sets enum class. Cannot be used with withDatatype(Datatype), withEntityClass(Class) and with predefined static methods.
    
    Parameters:
    
    enumClass - enum class
    
    Returns:
    
    input parameter
  - parameter
```
public static InputParameter parameter(java.lang.String id)
```
    Creates parameter with String type.
    
    Parameters:
    
    id - field id
    
    Returns:
    
    input parameter
  - stringParameter
```
public static InputParameter stringParameter(java.lang.String id)
```
    Creates parameter with String type.
    
    Parameters:
    
    id - field id
    
    Returns:
    
    input parameter
  - intParameter
```
public static InputParameter intParameter(java.lang.String id)
```
    Creates parameter with Integer type.
    
    Parameters:
    
    id - field id
    
    Returns:
    
    input parameter
  - doubleParameter
```
public static InputParameter doubleParameter(java.lang.String id)
```
    Creates parameter with Double type.
    
    Parameters:
    
    id - field id
    
    Returns:
    
    input parameter
  - bigDecimalParameter
```
public static InputParameter bigDecimalParameter(java.lang.String id)
```
    Creates parameter with BigDecimal type.
    
    Parameters:
    
    id - field id
    
    Returns:
    
    input parameter
  - longParameter
```
public static InputParameter longParameter(java.lang.String id)
```
    Creates parameter with Long type.
    
    Parameters:
    
    id - field id
    
    Returns:
    
    input parameter
  - dateParameter
```
public static InputParameter dateParameter(java.lang.String id)
```
    Creates parameter with Date type.
    
    Parameters:
    
    id - field id
    
    Returns:
    
    input parameter
  - timeParameter
```
public static InputParameter timeParameter(java.lang.String id)
```
    Creates parameter with Time type.
    
    Parameters:
    
    id - field id
    
    Returns:
    
    input parameter
  - dateTimeParameter
```
public static InputParameter dateTimeParameter(java.lang.String id)
```
    Creates parameter with DateTime type.
    
    Parameters:
    
    id - field id
    
    Returns:
    
    input parameter
  - localDateParameter
```
public static InputParameter localDateParameter(java.lang.String id)
```
    Creates parameter with LocalDate type.
    
    Parameters:
    
    id - field id
    
    Returns:
    
    input parameter
  - localDateTimeParameter
```
public static InputParameter localDateTimeParameter(java.lang.String id)
```
    Creates parameter with LocalDateTime type.
    
    Parameters:
    
    id - field id
    
    Returns:
    
    input parameter
  - localTimeParameter
```
public static InputParameter localTimeParameter(java.lang.String id)
```
    Creates parameter with LocalTime type.
    
    Parameters:
    
    id - field id
    
    Returns:
    
    input parameter
  - offsetDateTimeParameter
```
public static InputParameter offsetDateTimeParameter(java.lang.String id)
```
    Creates parameter with OffsetDateTime type.
    
    Parameters:
    
    id - field id
    
    Returns:
    
    input parameter
  - offsetTimeParameter
```
public static InputParameter offsetTimeParameter(java.lang.String id)
```
    Creates parameter with OffsetTime type.
    
    Parameters:
    
    id - field id
    
    Returns:
    
    input parameter
  - entityParameter
```
public static InputParameter entityParameter(java.lang.String id,
                                             java.lang.Class<? extends Entity> entityClass)
```
    Creates parameter with Entity type.
    
    Parameters:
    
    id - field id
    
    entityClass - entity class
    
    Returns:
    
    input parameter
  - booleanParameter
```
public static InputParameter booleanParameter(java.lang.String id)
```
    Creates parameter with Boolean type.
    
    Parameters:
    
    id - field id
    
    Returns:
    
    input parameter
  - fileParameter
```
public static InputParameter fileParameter(java.lang.String id)
```
    Creates parameter with FileDescriptor type.
    
    Parameters:
    
    id - field id
    
    Returns:
    
    input parameter
  - enumParameter
```
public static InputParameter enumParameter(java.lang.String id,
                                           java.lang.Class<? extends EnumClass> enumClass)
```
    Creates parameter with Enum type.
    
    Parameters:
    
    id - field id
    
    enumClass - enum class
    
    Returns:
    
    input parameter
  - checkNullDatatype
```
protected void checkNullDatatype(java.lang.String message)
```
  - checkNullEntityClass
```
protected void checkNullEntityClass(java.lang.String message)
```
  - checkNullEnumClass
```
protected void checkNullEnumClass(java.lang.String message)
```
  - checkNullDatatypeJavaClass
```
protected void checkNullDatatypeJavaClass(java.lang.String message)
```
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class InputParameter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

caption

required

datatype

field

defaultValue

entityClass

enumClass

datatypeJavaClass

Constructor Detail

InputParameter

Method Detail

getId

withId

getCaption

withCaption

isRequired

withRequired

getDatatype

withDatatype

withDatatypeJavaClass

getDatatypeJavaClass

getField

withField

getDefaultValue

withDefaultValue

getEntityClass

withEntityClass

getEnumClass

withEnumClass

parameter

stringParameter

intParameter

doubleParameter

bigDecimalParameter

longParameter

dateParameter

timeParameter

dateTimeParameter

localDateParameter

localDateTimeParameter

localTimeParameter

offsetDateTimeParameter

offsetTimeParameter

entityParameter

booleanParameter

fileParameter

enumParameter

checkNullDatatype

checkNullEntityClass

checkNullEnumClass

checkNullDatatypeJavaClass

equals

hashCode