com.bowstreet.generation
Interface BuilderInputDefinition

All Known Subinterfaces:

DynamicBuilderInputDefinition

public interface BuilderInputDefinition

Java representation of a BuilderInputDefinition.

Field Summary

static int	PT_ELEMENTS
static int	PT_NONE
static int	PT_VALUE
static int	TY_BOOLEAN boolean builder input
static int	TY_OBJECT Object builder input
static int	TY_STRING String builder input
static int	TY_XML XML builder input

Method Summary

java.util.Map	getArguments() Get the currently defined set of arguments.
java.lang.Object	getEmptyValueReplacement() Gets the default value if one is defined, else null.
java.lang.String	getHelpText() Gets help text for this input
java.lang.String	getName() Gets name of this input
int	getProfileType() See if this input can be profile-enabled.
java.lang.String	getPrompt() Gets prompt for this input
int	getType() Gets type of input (TY_x value)
boolean	isAvailableInPropertyPanel() true if this BuilderInput is allowed to be used in a property panel.
boolean	isCallable() See if this input should be part of callable builder API
boolean	isDeprecated() Return true if this input is marked deprecated
boolean	isRequired() Get required flag
boolean	isVisible() See if input is initially visible (can be shown/hidden by coordinator)
DynamicBuilderInputDefinition	makeDynamicCopy(BuilderInputs builderInputs) Create a DynamicBuilderInputDefinition (internal use)

Field Detail

PT_ELEMENTS

static final int PT_ELEMENTS

See Also:

Constant Field Values

PT_NONE

static final int PT_NONE

See Also:

Constant Field Values

PT_VALUE

static final int PT_VALUE

See Also:

Constant Field Values

TY_BOOLEAN

static final int TY_BOOLEAN

boolean builder input

See Also:

Constant Field Values

TY_OBJECT

static final int TY_OBJECT

Object builder input

See Also:

Constant Field Values

TY_STRING

static final int TY_STRING

String builder input

See Also:

Constant Field Values

TY_XML

static final int TY_XML

XML builder input

See Also:

Constant Field Values

Method Detail

getArguments

java.util.Map getArguments()

Get the currently defined set of arguments. Except in a DynamicBuilderInputDef, this will always be the ones defined in the bdef file.

getEmptyValueReplacement

java.lang.Object getEmptyValueReplacement()

Gets the default value if one is defined, else null. will be String or IXml

Returns:

default value

getHelpText

java.lang.String getHelpText()

Gets help text for this input

Returns:

The help text

getName

java.lang.String getName()

Gets name of this input

Returns:

The name

getProfileType

int getProfileType()

See if this input can be profile-enabled.

Returns:

PT_x value

getPrompt

java.lang.String getPrompt()

Gets prompt for this input

Returns:

The prompt String

getType

int getType()

Gets type of input (TY_x value)

Returns:

The type

isAvailableInPropertyPanel

boolean isAvailableInPropertyPanel()

true if this BuilderInput is allowed to be used in a property panel. Note that this doesn't mean isVisible is ignored. A BuilderInput will only be displayed in the property panel if this AND isVisible are true. The purpose of this value is to enable Builders to be used in the property panel without having to add any logic to their coordinators. This can be set to false int he BDEF if the field is to be excluded and the Coordinator doesn't need to know the difference between BuilderCallEditor and PropertyPanel.

Returns:

true if this BuilderInput is allowed to be used in a property panel

isCallable

boolean isCallable()

See if this input should be part of callable builder API

Returns:

true if input is in callable API

isDeprecated

boolean isDeprecated()

Return true if this input is marked deprecated

Returns:

true if input is deprecated

isRequired

boolean isRequired()

Get required flag

Returns:

true if builder input is required

isVisible

boolean isVisible()

See if input is initially visible (can be shown/hidden by coordinator)

Returns:

true if input initially visible.

makeDynamicCopy

DynamicBuilderInputDefinition makeDynamicCopy(BuilderInputs builderInputs)

Create a DynamicBuilderInputDefinition (internal use)