com.morpheusdata.model

Class OptionType

java.lang.Object

com.morpheusdata.model.MorpheusModel

com.morpheusdata.model.OptionType

public class OptionType
extends MorpheusModel

A Model representation of an input / option that is represented either in a UI or CLI. This allows an Integration to specify custom inputs for various configuration screens where custom data may need to be provided. This could include provisioning options as well as cloud configuration options. There are several different input types as well as display orders. This used to belong in seed within the main Morpheus appliance but since plugins are being separated this must be provided by the relevant provider interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OptionType.InputType

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	code
protected java.lang.String	defaultValue
protected java.lang.String	dependsOn
protected java.lang.Integer	displayOrder
protected java.lang.String	fieldContext
protected java.lang.String	fieldLabel
protected java.lang.String	fieldName
protected java.lang.String	helpText
protected OptionType.InputType	inputType
protected java.lang.String	name
protected java.lang.String	optionSource
protected java.lang.String	placeHolderText
protected java.lang.Boolean	required

Fields inherited from class com.morpheusdata.model.MorpheusModel

config, id

Constructor Summary

Constructors

Constructor and Description
OptionType()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCode() Gets the Unique code representation of the option type.
java.lang.String	getDefaultValue() Returns a String representation of the default value for the current Input.
java.lang.String	getDependsOn() Gets the code of an option type that this option type depends on.
java.lang.Integer	getDisplayOrder() Gets the display order position of the following Option Type.
java.lang.String	getFieldContext() Gets the field context which is the primary object the field is being saved onto.
java.lang.String	getFieldLabel() Gets the field label of the current Option Type.
java.lang.String	getFieldName() Gets the field name of the current option type.
java.lang.String	getHelpText() Gets the help text pertaining to an input.
OptionType.InputType	getInputType() Gets the type of Input this option type represents.
java.lang.String	getOptionSource() Gets the option source api method endpoint to hit when using the OptionType.InputType.SELECT option.
java.lang.String	getPlaceHolderText() Gets an inputs placeholder text for helpful display when awaiting input on a field.
java.lang.Boolean	getRequired() Gets the required flag off of the option type.
void	setCode(java.lang.String code) Sets the Unique code representation of the option type.
void	setDefaultValue(java.lang.String defaultValue) Sets a String representation of the default value for the current Input.
void	setDependsOn(java.lang.String dependsOn) Sets the code of an option type that this option type depends on.
void	setDisplayOrder(java.lang.Integer displayOrder) Sets the display order position of the following Option Type.
void	setFieldContext(java.lang.String fieldContext) Sets the field context which is the primary object the field is being saved onto.
void	setFieldLabel(java.lang.String fieldLabel) Sets the field label of the current Option Type.
void	setFieldName(java.lang.String fieldName) Sets the field name of the current option type.
void	setHelpText(java.lang.String helpText) Gets the help text pertaining to an input.
void	setInputType(OptionType.InputType inputType) Sets the type of Input this option type represents.
void	setOptionSource(java.lang.String optionSource) Sets the option source api method endpoint to hit when using the OptionType.InputType.SELECT option.
void	setPlaceHolderText(java.lang.String placeHolderText) Sets an inputs placeholder text for helpful display when awaiting input on a field.
void	setRequired(java.lang.Boolean required) Sets the required flag off of the option type.

Methods inherited from class com.morpheusdata.model.MorpheusModel

getConfig, getConfigMap, getConfigProperty, getDirtyProperties, getDirtyPropertyValues, getId, getProperties, markClean, markDirty, setConfig, setConfigMap, setId

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

code

protected java.lang.String code

fieldLabel

protected java.lang.String fieldLabel

fieldName

protected java.lang.String fieldName

fieldContext

protected java.lang.String fieldContext

inputType

protected OptionType.InputType inputType

displayOrder

protected java.lang.Integer displayOrder

placeHolderText

protected java.lang.String placeHolderText

defaultValue

protected java.lang.String defaultValue

required

protected java.lang.Boolean required

helpText

protected java.lang.String helpText

optionSource

protected java.lang.String optionSource

dependsOn

protected java.lang.String dependsOn

Constructor Detail

OptionType

public OptionType()

Method Detail

getCode

public java.lang.String getCode()

Gets the Unique code representation of the option type. This is used for tracking changes and should be globally unique. It also allows for multiple provider types to reuse the same input field if they share the same option set.

Returns:

unique String code identifier for this particular Option Type

setCode

public void setCode(java.lang.String code)

Sets the Unique code representation of the option type. This is used for tracking changes and should be globally unique. It also allows for multiple provider types to reuse the same input field if they share the same option set.

Parameters:

code - unique String code identifier for this particular Option Type

getFieldLabel

public java.lang.String getFieldLabel()

Gets the field label of the current Option Type. The Field Label is the human readable label that is typically displayed left of the input prompt in most UI representations.

Returns:

Human readable Field Label

setFieldLabel

public void setFieldLabel(java.lang.String fieldLabel)

Sets the field label of the current Option Type. The Field Label is the human readable label that is typically displayed left of the input prompt in most UI representations.

Parameters:

fieldLabel - Human readable Field Label

getFieldName

public java.lang.String getFieldName()

Gets the field name of the current option type. The Field Name is typically the actual property name the field correlates to. It can be period seperated for referencing nested objects and is typically combined with the fieldContext. (example: config.provider.name).

Returns:

the field name of the property being saved

setFieldName

public void setFieldName(java.lang.String fieldName)

Sets the field name of the current option type. The Field Name is typically the actual property name the field correlates to. It can be period seperated for referencing nested objects and is typically combined with the fieldContext. (example: config.provider.name).

Parameters:

fieldName - the field name of the property being saved

getFieldContext

public java.lang.String getFieldContext()

Gets the field context which is the primary object the field is being saved onto. This could be something like 'instance' or 'config'. It typically gets combined with field names such as a fieldName of 'name' with a context of 'instance' would get combined to save onto 'instance.name' within Morpheus data model.

Returns:

the field context to be used for determining where the value is saved

setFieldContext

public void setFieldContext(java.lang.String fieldContext)

Sets the field context which is the primary object the field is being saved onto. This could be something like 'instance' or 'config'. It typically gets combined with field names such as a fieldName of 'name' with a context of 'instance' would get combined to save onto 'instance.name' within Morpheus data model.

Parameters:

fieldContext - the field context to be used for determining where the value is saved

getInputType

public OptionType.InputType getInputType()

Gets the type of Input this option type represents. This could range in type and be anything from a free form text field to a dropdown with remote loaded data from an getOptionSource().

Returns:

the type of input this option type correlates to.

setInputType

public void setInputType(OptionType.InputType inputType)

Sets the type of Input this option type represents. This could range in type and be anything from a free form text field to a dropdown with remote loaded data from an getOptionSource().

Parameters:

inputType - the type of input this option type correlates to.

getDisplayOrder

public java.lang.Integer getDisplayOrder()

Gets the display order position of the following Option Type. The Display order is sorted ascending numerically. Sometimes it may be advised to use multiples when incrementing the display order to allow for injection points between them.

Returns:

the Numerical display order (typically starting at 0) of the input.

setDisplayOrder

public void setDisplayOrder(java.lang.Integer displayOrder)

Sets the display order position of the following Option Type. The Display order is sorted ascending numerically. Sometimes it may be advised to use multiples when incrementing the display order to allow for injection points between them.

Parameters:

displayOrder - the Numerical display order (typically starting at 0) of the input.

getPlaceHolderText

public java.lang.String getPlaceHolderText()

Gets an inputs placeholder text for helpful display when awaiting input on a field. A placeholder text can be helpful hint to the user as to what type of input should go in the associated field.

Returns:

the place holder input text

setPlaceHolderText

public void setPlaceHolderText(java.lang.String placeHolderText)

Sets an inputs placeholder text for helpful display when awaiting input on a field. A placeholder text can be helpful hint to the user as to what type of input should go in the associated field.

Parameters:

placeHolderText - the place holder input text

getDefaultValue

public java.lang.String getDefaultValue()

Returns a String representation of the default value for the current Input. When a user first is prompted for input if no input is given by the user, this default value is used.

Returns:

the default value of the following input option

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)

Sets a String representation of the default value for the current Input. When a user first is prompted for input if no input is given by the user, this default value is used.

Parameters:

defaultValue - the default value of the following input option

getRequired

public java.lang.Boolean getRequired()

Gets the required flag off of the option type. This determines if an input is user required or not. The CLI and UI will use this flag as an initial validation step to ensure a user has at least entered a value.

Returns:

the required flag to determine if an input requires a value or not

setRequired

public void setRequired(java.lang.Boolean required)

Sets the required flag off of the option type. This determines if an input is user required or not. The CLI and UI will use this flag as an initial validation step to ensure a user has at least entered a value.

Parameters:

required - the required flag to determine if an input requires a value or not

getHelpText

public java.lang.String getHelpText()

Gets the help text pertaining to an input. Some inputs have help text that display below them to give better context for the user when determining what value to enter. This data is optional.

Returns:

the descriptive help block of text for an input

setHelpText

public void setHelpText(java.lang.String helpText)

Gets the help text pertaining to an input. Some inputs have help text that display below them to give better context for the user when determining what value to enter. This data is optional.

Parameters:

helpText - the descriptive help block of text for an input

getOptionSource

public java.lang.String getOptionSource()

Gets the option source api method endpoint to hit when using the OptionType.InputType.SELECT option. This allows a remote data source query to be queried for loading dynamic data. It also can take a POST request with the values of previously entered inputs to use as a way to filter the available options.

Returns:

option source api method for loading dynamic options

setOptionSource

public void setOptionSource(java.lang.String optionSource)

Sets the option source api method endpoint to hit when using the OptionType.InputType.SELECT option. This allows a remote data source query to be queried for loading dynamic data. It also can take a POST request with the values of previously entered inputs to use as a way to filter the available options.

Parameters:

optionSource - option source api method for loading dynamic options

getDependsOn

public java.lang.String getDependsOn()

Gets the code of an option type that this option type depends on. Some option types depend on input from previous option types. By placing the code or fieldName representation of that field into this input, this field will refresh upon changes made to that previous input

Returns:

the code of the parent option type

setDependsOn

public void setDependsOn(java.lang.String dependsOn)

Sets the code of an option type that this option type depends on. Some option types depend on input from previous option types. By placing the code or fieldName representation of that field into this input, this field will refresh upon changes made to that previous input

Parameters:

dependsOn - the code of the parent option type