com.orchestranetworks.addon.dpra.function

Class InputDefinition

java.lang.Object

com.orchestranetworks.addon.dpra.function.InputDefinition

public final class InputDefinition
extends Object

Specifies the input definition of a function.

Since:

4.2.0

See Also:

FunctionDefinition.getInputDefinitions()

Method Summary

Modifier and Type	Method and Description
static InputDefinition	forBoolean(String name, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description, boolean defaultValue) Creates an instance of boolean input.
static InputDefinition	forDateTime(String name, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description, Date defaultValue) Creates an instance of date time input.
static InputDefinition	forDateTimes(String name, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description, Date... defaultValues) Creates an instance of multi-valued date time input.
static InputDefinition	forDecimal(String name, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description, BigDecimal defaultValue) Creates an instance of decimal input.
static InputDefinition	forDecimals(String name, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description, BigDecimal... defaultValues) Creates an instance of multi-valued decimal input.
static InputDefinition	forInteger(String name, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description, int defaultValue) Creates an instance of integer input.
static InputDefinition	forIntegers(String name, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description, Integer... defaultValues) Creates an instance of multi-valued integer input.
static InputDefinition	forString(String name, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description, String defaultValue) Creates an instance of string input.
static InputDefinition	forStrings(String name, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description, String... defaultValues) Creates an instance of multi-valued string input.
com.orchestranetworks.schema.SchemaTypeName	getDataType() Return the data type.
com.onwbp.base.text.UserMessage	getDescription() Returns the description.
com.onwbp.base.text.UserMessage	getLabel() Returns the input definition label.
String	getName() Returns the unique name.
boolean	isMultiValued() Returns true if the input has multiple values.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

forBoolean

public static InputDefinition forBoolean(String name,
                                         com.onwbp.base.text.UserMessage label,
                                         com.onwbp.base.text.UserMessage description,
                                         boolean defaultValue)

Creates an instance of boolean input.

Parameters:

name - The unique name of the input.

label - The localized label.

description - The localized description.

defaultValue - The default value.

forDateTime

public static InputDefinition forDateTime(String name,
                                          com.onwbp.base.text.UserMessage label,
                                          com.onwbp.base.text.UserMessage description,
                                          Date defaultValue)

Creates an instance of date time input.

Parameters:

name - The unique name of the input.

label - The localized label.

description - The localized description.

defaultValue - The default value.

forDateTimes

public static InputDefinition forDateTimes(String name,
                                           com.onwbp.base.text.UserMessage label,
                                           com.onwbp.base.text.UserMessage description,
                                           Date... defaultValues)

Creates an instance of multi-valued date time input.

Parameters:

name - The unique name of the input.

label - The localized label.

description - The localized description.

defaultValues - The default values.

forDecimal

public static InputDefinition forDecimal(String name,
                                         com.onwbp.base.text.UserMessage label,
                                         com.onwbp.base.text.UserMessage description,
                                         BigDecimal defaultValue)

Creates an instance of decimal input.

Parameters:

name - The unique name of the input.

label - The localized label.

description - The localized description.

defaultValue - The default value.

forDecimals

public static InputDefinition forDecimals(String name,
                                          com.onwbp.base.text.UserMessage label,
                                          com.onwbp.base.text.UserMessage description,
                                          BigDecimal... defaultValues)

Creates an instance of multi-valued decimal input.

Parameters:

name - The unique name of the input.

label - The localized label.

description - The localized description.

defaultValues - The default values.

forInteger

public static InputDefinition forInteger(String name,
                                         com.onwbp.base.text.UserMessage label,
                                         com.onwbp.base.text.UserMessage description,
                                         int defaultValue)

Creates an instance of integer input.

Parameters:

name - The unique name of the input.

label - The localized label.

description - The localized description.

defaultValue - The default value.

forIntegers

public static InputDefinition forIntegers(String name,
                                          com.onwbp.base.text.UserMessage label,
                                          com.onwbp.base.text.UserMessage description,
                                          Integer... defaultValues)

Creates an instance of multi-valued integer input.

Parameters:

name - The unique name of the input.

label - The localized label.

description - The localized description.

defaultValues - The default values.

forString

public static InputDefinition forString(String name,
                                        com.onwbp.base.text.UserMessage label,
                                        com.onwbp.base.text.UserMessage description,
                                        String defaultValue)

Creates an instance of string input.

Parameters:

name - The unique name of the input.

label - The localized label.

description - The localized description.

defaultValue - The default value.

forStrings

public static InputDefinition forStrings(String name,
                                         com.onwbp.base.text.UserMessage label,
                                         com.onwbp.base.text.UserMessage description,
                                         String... defaultValues)

Creates an instance of multi-valued string input.

Parameters:

name - The unique name of the input.

label - The localized label.

description - The localized description.

defaultValues - The default values.

getName

public String getName()

Returns the unique name.

getLabel

public com.onwbp.base.text.UserMessage getLabel()

Returns the input definition label.

getDescription

public com.onwbp.base.text.UserMessage getDescription()

Returns the description.

getDataType

public com.orchestranetworks.schema.SchemaTypeName getDataType()

Return the data type.

isMultiValued

public boolean isMultiValued()

Returns true if the input has multiple values.