Package 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 Description static class
OptionType.InputType
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.String
addTemplate
protected java.lang.Boolean
advanced
protected java.lang.String
apiList
protected java.lang.String
blockCLass
protected java.lang.String
category
protected java.lang.String
code
protected java.lang.Boolean
contextualDefault
protected java.lang.String
conversionType
protected java.lang.Boolean
creatable
protected java.lang.Boolean
custom
protected java.lang.String
defaultValue
protected java.lang.String
dependsOn
protected java.lang.Integer
displayOrder
protected java.lang.Boolean
displayValueOnDetails
protected java.lang.Boolean
editable
protected java.lang.String
editTemplate
protected java.lang.Boolean
enabled
protected java.lang.String
evarName
protected java.lang.Boolean
excludeFromSearch
protected java.lang.Boolean
exportEvar
protected java.lang.Boolean
exportMeta
protected java.lang.String
fieldAddOn
protected java.lang.String
fieldClass
protected java.lang.String
fieldCode
protected java.lang.String
fieldComponent
protected java.lang.String
fieldCondition
protected java.lang.String
fieldContext
protected java.lang.String
fieldEvar
protected java.lang.String
fieldGetContext
protected java.lang.String
fieldGetName
protected java.lang.String
fieldGroup
protected java.lang.String
fieldGroupI18nCode
protected java.lang.String
fieldInput
protected java.lang.String
fieldLabel
protected java.lang.String
fieldName
protected java.lang.String
fieldSet
protected java.lang.String
fieldSetContext
protected java.lang.String
fieldSetName
protected java.lang.Integer
fieldSize
protected java.lang.String
format
protected java.lang.Boolean
global
protected java.lang.Boolean
groupExpand
protected java.lang.String
helpText
protected java.lang.String
helpTextI18nCode
protected java.lang.String
idTemplate
protected java.lang.Boolean
ignoreField
this field is for form functionality only, will not save to the domain object.protected OptionType.InputType
inputType
protected java.lang.String
labelClass
protected java.lang.Boolean
localCredential
these fields are for indicating a field is input for a local credentialprotected java.lang.Long
maxLength
protected java.lang.Long
maxVal
protected java.lang.Long
minLength
protected java.lang.Long
minVal
protected java.lang.Boolean
multiTenant
to support multitenant check in gspprotected java.lang.String
name
protected java.lang.Boolean
noBlank
protected java.lang.String
noSelection
protected java.lang.String
optionSource
protected java.lang.String
optionSourceType
protected java.lang.Boolean
ownerEditable
protected java.lang.String
placeHolderText
protected java.lang.Boolean
required
protected java.lang.String
requireOnCode
Controls when this optionType is indicated as required on the form Format is 'fieldName:regex'.protected java.lang.Boolean
secretField
protected java.lang.Boolean
showOnCreate
protected java.lang.Boolean
showOnEdit
protected java.lang.Boolean
tenantEditable
protected java.lang.Boolean
tenantVisible
protected java.lang.String
verifyPattern
protected java.lang.String
viewTemplate
protected java.lang.String
visibleOnCode
Controls when this optionType is visible Format is 'fieldName:regex'.protected java.lang.String
wrapperClass
protected java.lang.String
wrapperSelector
-
Fields inherited from class com.morpheusdata.model.MorpheusModel
config, id
-
-
Constructor Summary
Constructors Constructor Description OptionType()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getAddTemplate()
java.lang.Boolean
getAdvanced()
java.lang.String
getApiList()
java.lang.String
getBlockCLass()
java.lang.String
getCategory()
java.lang.String
getCode()
Gets the Unique code representation of the option type.java.lang.Boolean
getContextualDefault()
java.lang.String
getConversionType()
java.lang.Boolean
getCreatable()
java.lang.Boolean
getCustom()
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.String
getDependsOnCode()
Convenience method for binding data, seegetDependsOn
java.lang.Integer
getDisplayOrder()
Gets the display order position of the following Option Type.java.lang.Boolean
getDisplayValueOnDetails()
Specifies if this option type is visible on resource detail views.java.lang.Boolean
getEditable()
Specifies whether this option type is editable on edit.java.lang.String
getEditTemplate()
java.lang.Boolean
getEnabled()
java.lang.String
getEvarName()
java.lang.Boolean
getExcludeFromSearch()
java.lang.Boolean
getExportEvar()
java.lang.Boolean
getExportMeta()
java.lang.String
getFieldAddOn()
java.lang.String
getFieldClass()
java.lang.String
getFieldCode()
java.lang.String
getFieldComponent()
java.lang.String
getFieldCondition()
java.lang.String
getFieldContext()
Gets the field context which is the primary object the field is being saved onto.java.lang.String
getFieldEvar()
java.lang.String
getFieldGetContext()
java.lang.String
getFieldGetName()
java.lang.String
getFieldGroup()
Gets the field group which is the name that is used to group fields together in the user interface.java.lang.String
getFieldGroupCode()
Convenience method for binding data, seegetFieldGroupI18nCode
java.lang.String
getFieldGroupI18nCode()
java.lang.String
getFieldInput()
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
getFieldSet()
java.lang.String
getFieldSetContext()
java.lang.String
getFieldSetName()
java.lang.Integer
getFieldSize()
java.lang.String
getFormat()
java.lang.Boolean
getGlobal()
java.lang.Boolean
getGroupExpand()
java.lang.String
getHelpBlock()
java.lang.String
getHelpBlockCode()
Convenience method for binding data, seegetHelpTextI18nCode
java.lang.String
getHelpText()
Gets the help text pertaining to an input.java.lang.String
getHelpTextI18nCode()
java.lang.String
getIdTemplate()
java.lang.Boolean
getIgnoreField()
OptionType.InputType
getInputType()
Gets the type of Input this option type represents.java.lang.String
getLabelClass()
java.lang.Boolean
getLocalCredential()
java.lang.Long
getMaxLength()
java.lang.Long
getMaxVal()
java.lang.Long
getMinLength()
java.lang.Long
getMinVal()
java.lang.Boolean
getMultiTenant()
java.lang.String
getName()
java.lang.Boolean
getNoBlank()
java.lang.String
getNoSelection()
java.lang.String
getOptionSource()
Gets the option source api method endpoint to hit when using theOptionType.InputType.SELECT
option.java.lang.String
getOptionSourceType()
java.lang.Boolean
getOwnerEditable()
java.lang.String
getPlaceHolder()
Convenience method for binding data, seegetPlaceHolderText
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.java.lang.String
getRequireOnCode()
java.lang.Boolean
getSecretField()
java.lang.Boolean
getShowOnCreate()
Specifies whether this option type is visible on create forms.java.lang.Boolean
getShowOnEdit()
Specifies if this option type is visible on edit forms.java.lang.Boolean
getTenantEditable()
java.lang.Boolean
getTenantVisible()
java.lang.String
getVerifyPattern()
java.lang.String
getViewTemplate()
java.lang.String
getVisibleOnCode()
java.lang.String
getWrapperClass()
java.lang.String
getWrapperSelector()
void
setAddTemplate(java.lang.String addTemplate)
void
setAdvanced(java.lang.Boolean advanced)
void
setApiList(java.lang.String apiList)
void
setBlockCLass(java.lang.String blockCLass)
void
setCategory(java.lang.String category)
void
setCode(java.lang.String code)
Sets the Unique code representation of the option type.void
setContextualDefault(java.lang.Boolean contextualDefault)
void
setConversionType(java.lang.String conversionType)
void
setCreatable(java.lang.Boolean creatable)
void
setCustom(java.lang.Boolean custom)
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
setDependsOnCode(java.lang.String dependsOn)
Convenience method for binding data, seesetDependsOn
void
setDisplayOrder(java.lang.Integer displayOrder)
Sets the display order position of the following Option Type.void
setDisplayValueOnDetails(java.lang.Boolean displayValueOnDetails)
Sets if this option type is visible on resource detail views.void
setEditable(java.lang.Boolean editable)
Sets whether or not this option type is editable.void
setEditTemplate(java.lang.String editTemplate)
void
setEnabled(java.lang.Boolean enabled)
void
setEvarName(java.lang.String evarName)
void
setExcludeFromSearch(java.lang.Boolean excludeFromSearch)
void
setExportEvar(java.lang.Boolean exportEvar)
void
setExportMeta(java.lang.Boolean exportMeta)
void
setFieldAddOn(java.lang.String fieldAddOn)
void
setFieldClass(java.lang.String fieldClass)
void
setFieldCode(java.lang.String fieldCode)
void
setFieldComponent(java.lang.String fieldComponent)
void
setFieldCondition(java.lang.String fieldCondition)
void
setFieldContext(java.lang.String fieldContext)
Sets the field context which is the primary object the field is being saved onto.void
setFieldEvar(java.lang.String fieldEvar)
void
setFieldGetContext(java.lang.String fieldGetContext)
void
setFieldGetName(java.lang.String fieldGetName)
void
setFieldGroup(java.lang.String fieldGroup)
Sets the field group which is the name that is used to group fields together in the user interface.void
setFieldGroupCode(java.lang.String fieldGroupI18nCode)
Convenience method for binding data, seesetFieldGroupI18nCode
void
setFieldGroupI18nCode(java.lang.String fieldGroupI18nCode)
void
setFieldInput(java.lang.String fieldInput)
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
setFieldSet(java.lang.String fieldSet)
void
setFieldSetContext(java.lang.String fieldSetContext)
void
setFieldSetName(java.lang.String fieldSetName)
void
setFieldSize(java.lang.Integer fieldSize)
void
setFormat(java.lang.String format)
void
setGlobal(java.lang.Boolean global)
void
setGroupExpand(java.lang.Boolean groupExpand)
void
setHelpBlock(java.lang.String helpText)
void
setHelpBlockCode(java.lang.String helpTextI18nCode)
Convenience method for binding data, seesetHelpTextI18nCode
void
setHelpText(java.lang.String helpText)
Gets the help text pertaining to an input.void
setHelpTextI18nCode(java.lang.String helpTextI18nCode)
void
setIdTemplate(java.lang.String idTemplate)
void
setIgnoreField(java.lang.Boolean ignoreField)
void
setInputType(OptionType.InputType inputType)
Sets the type of Input this option type represents.void
setLabelClass(java.lang.String labelClass)
void
setLocalCredential(java.lang.Boolean localCredential)
void
setMaxLength(java.lang.Long maxLength)
void
setMaxVal(java.lang.Long maxVal)
void
setMinLength(java.lang.Long minLength)
void
setMinVal(java.lang.Long minVal)
void
setMultiTenant(java.lang.Boolean multiTenant)
void
setName(java.lang.String name)
void
setNoBlank(java.lang.Boolean noBlank)
void
setNoSelection(java.lang.String noSelection)
void
setOptionSource(java.lang.String optionSource)
Sets the option source api method endpoint to hit when using theOptionType.InputType.SELECT
option.void
setOptionSourceType(java.lang.String optionSourceType)
void
setOwnerEditable(java.lang.Boolean ownerEditable)
void
setPlaceHolder(java.lang.String placeHolderText)
Convenience method for binding data, seesetPlaceHolderText
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.void
setRequireOnCode(java.lang.String requireOnCode)
void
setSecretField(java.lang.Boolean secretField)
void
setShowOnCreate(java.lang.Boolean showOnCreate)
Sets whether or not this option type is visible on create forms.void
setShowOnEdit(java.lang.Boolean showOnEdit)
Sets if this option type is visible on edit forms.void
setTenantEditable(java.lang.Boolean tenantEditable)
void
setTenantVisible(java.lang.Boolean tenantVisible)
void
setVerifyPattern(java.lang.String verifyPattern)
void
setViewTemplate(java.lang.String viewTemplate)
void
setVisibleOnCode(java.lang.String visibleOnCode)
void
setWrapperClass(java.lang.String wrapperClass)
void
setWrapperSelector(java.lang.String wrapperSelector)
-
Methods inherited from class com.morpheusdata.model.MorpheusModel
getConfig, getConfigMap, getConfigProperty, getDirtyProperties, getDirtyPropertyValues, getId, getProperties, isDirty, markClean, markDirty, markDirty, setConfig, setConfigMap, setConfigProperty, setId
-
-
-
-
Field Detail
-
name
protected java.lang.String name
-
code
protected java.lang.String code
-
category
protected java.lang.String category
-
required
protected java.lang.Boolean required
-
editable
protected java.lang.Boolean editable
-
enabled
protected java.lang.Boolean enabled
-
noSelection
protected java.lang.String noSelection
-
minVal
protected java.lang.Long minVal
-
maxVal
protected java.lang.Long maxVal
-
minLength
protected java.lang.Long minLength
-
maxLength
protected java.lang.Long maxLength
-
fieldContext
protected java.lang.String fieldContext
-
fieldClass
protected java.lang.String fieldClass
-
fieldLabel
protected java.lang.String fieldLabel
-
fieldCode
protected java.lang.String fieldCode
-
fieldName
protected java.lang.String fieldName
-
fieldGetName
protected java.lang.String fieldGetName
-
fieldSetName
protected java.lang.String fieldSetName
-
fieldGetContext
protected java.lang.String fieldGetContext
-
fieldSetContext
protected java.lang.String fieldSetContext
-
fieldInput
protected java.lang.String fieldInput
-
fieldSize
protected java.lang.Integer fieldSize
-
fieldSet
protected java.lang.String fieldSet
-
fieldCondition
protected java.lang.String fieldCondition
-
fieldAddOn
protected java.lang.String fieldAddOn
-
fieldEvar
protected java.lang.String fieldEvar
-
fieldComponent
protected java.lang.String fieldComponent
-
fieldGroup
protected java.lang.String fieldGroup
-
fieldGroupI18nCode
protected java.lang.String fieldGroupI18nCode
-
labelClass
protected java.lang.String labelClass
-
blockCLass
protected java.lang.String blockCLass
-
wrapperClass
protected java.lang.String wrapperClass
-
wrapperSelector
protected java.lang.String wrapperSelector
-
inputType
protected OptionType.InputType inputType
-
displayOrder
protected java.lang.Integer displayOrder
-
placeHolderText
protected java.lang.String placeHolderText
-
defaultValue
protected java.lang.String defaultValue
-
helpText
protected java.lang.String helpText
-
helpTextI18nCode
protected java.lang.String helpTextI18nCode
-
optionSourceType
protected java.lang.String optionSourceType
-
optionSource
protected java.lang.String optionSource
-
dependsOn
protected java.lang.String dependsOn
-
requireOnCode
protected java.lang.String requireOnCode
Controls when this optionType is indicated as required on the form Format is 'fieldName:regex'. e.g. 'config.haMode:ACTIVE_STANDBY' Where fieldName is the full name of another input on the form and regex is a regular expression used to test against the value for the input named 'fieldName'. If a match is obtained, the optionType is inidicated as required. Default match behavior for multiple rules is matchAny. The match type can be customized with a 'matchAll::' or 'matchAny::' prefix. Examples: matchAll::domain.fieldName1:value1,config.fieldName2:value1,domain.fieldName3:(value1|value2|value3) matchAny::config.filedName1:value1,config.fieldName2:^some.*?regex$ Usage logic can be found in option-type-form.js
-
visibleOnCode
protected java.lang.String visibleOnCode
Controls when this optionType is visible Format is 'fieldName:regex'. e.g. 'config.haMode:ACTIVE_STANDBY' Where fieldName is the full name of another input on the form and regex is a regular expression used to test against the value for the input named 'fieldName'. If a match is obtained, the optionType is visible. Default match behavior for multiple rules is matchAny. The match type can be customized with a 'matchAll::' or 'matchAny' prefix. Examples: matchAll::domain.fieldName1:value1,config.fieldName2:value1,domain.fieldName3:(value1|value2|value3) matchAny::config.filedName1:value1,config.fieldName2:^some.*?regex$ Usage logic can be found in option-type-form.js
-
showOnEdit
protected java.lang.Boolean showOnEdit
-
displayValueOnDetails
protected java.lang.Boolean displayValueOnDetails
-
showOnCreate
protected java.lang.Boolean showOnCreate
-
verifyPattern
protected java.lang.String verifyPattern
-
format
protected java.lang.String format
-
evarName
protected java.lang.String evarName
-
conversionType
protected java.lang.String conversionType
-
viewTemplate
protected java.lang.String viewTemplate
-
editTemplate
protected java.lang.String editTemplate
-
addTemplate
protected java.lang.String addTemplate
-
idTemplate
protected java.lang.String idTemplate
-
apiList
protected java.lang.String apiList
-
ownerEditable
protected java.lang.Boolean ownerEditable
-
tenantEditable
protected java.lang.Boolean tenantEditable
-
tenantVisible
protected java.lang.Boolean tenantVisible
-
creatable
protected java.lang.Boolean creatable
-
global
protected java.lang.Boolean global
-
custom
protected java.lang.Boolean custom
-
advanced
protected java.lang.Boolean advanced
-
exportEvar
protected java.lang.Boolean exportEvar
-
exportMeta
protected java.lang.Boolean exportMeta
-
groupExpand
protected java.lang.Boolean groupExpand
-
noBlank
protected java.lang.Boolean noBlank
-
contextualDefault
protected java.lang.Boolean contextualDefault
-
secretField
protected java.lang.Boolean secretField
-
excludeFromSearch
protected java.lang.Boolean excludeFromSearch
-
ignoreField
protected java.lang.Boolean ignoreField
this field is for form functionality only, will not save to the domain object.
-
localCredential
protected java.lang.Boolean localCredential
these fields are for indicating a field is input for a local credential
-
multiTenant
protected java.lang.Boolean multiTenant
to support multitenant check in gsp
-
-
Method Detail
-
getName
public java.lang.String getName()
-
setName
public void setName(java.lang.String name)
-
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
-
getFieldGroup
public java.lang.String getFieldGroup()
Gets the field group which is the name that is used to group fields together in the user interface. To have all fields at the same level, do not specify a field group.- Returns:
- the field group to be used for grouping fields together
-
setFieldGroup
public void setFieldGroup(java.lang.String fieldGroup)
Sets the field group which is the name that is used to group fields together in the user interface. To have all fields at the same level, do not specify a field group.- Parameters:
fieldGroup
- the field group to be used for grouping fields together
-
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 angetOptionSource()
.- 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 angetOptionSource()
.- 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
-
getPlaceHolder
public java.lang.String getPlaceHolder()
Convenience method for binding data, seegetPlaceHolderText
-
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
-
setPlaceHolder
public void setPlaceHolder(java.lang.String placeHolderText)
Convenience method for binding data, seesetPlaceHolderText
-
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
-
getHelpBlock
public java.lang.String getHelpBlock()
-
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
-
setHelpBlock
public void setHelpBlock(java.lang.String helpText)
-
getOptionSource
public java.lang.String getOptionSource()
Gets the option source api method endpoint to hit when using theOptionType.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. This should be globally unique.- 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 theOptionType.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. This should be globally unique.- 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
-
getDependsOnCode
public java.lang.String getDependsOnCode()
Convenience method for binding data, seegetDependsOn
-
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
-
setDependsOnCode
public void setDependsOnCode(java.lang.String dependsOn)
Convenience method for binding data, seesetDependsOn
-
getEditable
public java.lang.Boolean getEditable()
Specifies whether this option type is editable on edit. This sometimes is the case where a field can be set on create but not changed later- Returns:
- whether or not this option type value is editable
-
setEditable
public void setEditable(java.lang.Boolean editable)
Sets whether or not this option type is editable. This sometimes is the case where a field can be set on create but not changed later- Parameters:
editable
- whether or not this field is editable upon edit and not just create
-
getShowOnCreate
public java.lang.Boolean getShowOnCreate()
Specifies whether this option type is visible on create forms. This sometimes is the case where a field can be set on create but not changed later nor does it make sense to display it after create.- Returns:
- whether or not this option type is visible upon create
-
setShowOnCreate
public void setShowOnCreate(java.lang.Boolean showOnCreate)
Sets whether or not this option type is visible on create forms. This sometimes is the case where a field can be set on create but not changed later, nor does it make sense to display it after create.- Parameters:
showOnCreate
- whether or not this option type is visible upon create
-
getShowOnEdit
public java.lang.Boolean getShowOnEdit()
Specifies if this option type is visible on edit forms. This sometimes is the case where a field can be set on create but not changed later nor does it make sense to display it after create.- Returns:
- determines if this option type is visible upon edit
-
setShowOnEdit
public void setShowOnEdit(java.lang.Boolean showOnEdit)
Sets if this option type is visible on edit forms. This sometimes is the case where a field can be set on create but not changed later, nor does it make sense to display it after create.- Parameters:
showOnEdit
- determines if this option type is visible upon edit
-
getFieldClass
public java.lang.String getFieldClass()
-
setFieldClass
public void setFieldClass(java.lang.String fieldClass)
-
getLocalCredential
public java.lang.Boolean getLocalCredential()
-
setLocalCredential
public void setLocalCredential(java.lang.Boolean localCredential)
-
getDisplayValueOnDetails
public java.lang.Boolean getDisplayValueOnDetails()
Specifies if this option type is visible on resource detail views.- Returns:
- determines if this option type is visible upon edit
-
setDisplayValueOnDetails
public void setDisplayValueOnDetails(java.lang.Boolean displayValueOnDetails)
Sets if this option type is visible on resource detail views.- Parameters:
displayValueOnDetails
- determines if this option type is visible on resource detail views
-
getCategory
public java.lang.String getCategory()
-
setCategory
public void setCategory(java.lang.String category)
-
getEnabled
public java.lang.Boolean getEnabled()
-
setEnabled
public void setEnabled(java.lang.Boolean enabled)
-
getNoSelection
public java.lang.String getNoSelection()
-
setNoSelection
public void setNoSelection(java.lang.String noSelection)
-
getMinVal
public java.lang.Long getMinVal()
-
setMinVal
public void setMinVal(java.lang.Long minVal)
-
getMaxVal
public java.lang.Long getMaxVal()
-
setMaxVal
public void setMaxVal(java.lang.Long maxVal)
-
getMinLength
public java.lang.Long getMinLength()
-
setMinLength
public void setMinLength(java.lang.Long minLength)
-
getMaxLength
public java.lang.Long getMaxLength()
-
setMaxLength
public void setMaxLength(java.lang.Long maxLength)
-
getFieldCode
public java.lang.String getFieldCode()
-
setFieldCode
public void setFieldCode(java.lang.String fieldCode)
-
getFieldGetName
public java.lang.String getFieldGetName()
-
setFieldGetName
public void setFieldGetName(java.lang.String fieldGetName)
-
getFieldSetName
public java.lang.String getFieldSetName()
-
setFieldSetName
public void setFieldSetName(java.lang.String fieldSetName)
-
getFieldGetContext
public java.lang.String getFieldGetContext()
-
setFieldGetContext
public void setFieldGetContext(java.lang.String fieldGetContext)
-
getFieldSetContext
public java.lang.String getFieldSetContext()
-
setFieldSetContext
public void setFieldSetContext(java.lang.String fieldSetContext)
-
getFieldInput
public java.lang.String getFieldInput()
-
setFieldInput
public void setFieldInput(java.lang.String fieldInput)
-
getFieldSize
public java.lang.Integer getFieldSize()
-
setFieldSize
public void setFieldSize(java.lang.Integer fieldSize)
-
getFieldSet
public java.lang.String getFieldSet()
-
setFieldSet
public void setFieldSet(java.lang.String fieldSet)
-
getFieldCondition
public java.lang.String getFieldCondition()
-
setFieldCondition
public void setFieldCondition(java.lang.String fieldCondition)
-
getFieldAddOn
public java.lang.String getFieldAddOn()
-
setFieldAddOn
public void setFieldAddOn(java.lang.String fieldAddOn)
-
getFieldEvar
public java.lang.String getFieldEvar()
-
setFieldEvar
public void setFieldEvar(java.lang.String fieldEvar)
-
getFieldComponent
public java.lang.String getFieldComponent()
-
setFieldComponent
public void setFieldComponent(java.lang.String fieldComponent)
-
getFieldGroupI18nCode
public java.lang.String getFieldGroupI18nCode()
-
getFieldGroupCode
public java.lang.String getFieldGroupCode()
Convenience method for binding data, seegetFieldGroupI18nCode
-
setFieldGroupI18nCode
public void setFieldGroupI18nCode(java.lang.String fieldGroupI18nCode)
-
setFieldGroupCode
public void setFieldGroupCode(java.lang.String fieldGroupI18nCode)
Convenience method for binding data, seesetFieldGroupI18nCode
-
getLabelClass
public java.lang.String getLabelClass()
-
setLabelClass
public void setLabelClass(java.lang.String labelClass)
-
getBlockCLass
public java.lang.String getBlockCLass()
-
setBlockCLass
public void setBlockCLass(java.lang.String blockCLass)
-
getWrapperClass
public java.lang.String getWrapperClass()
-
setWrapperClass
public void setWrapperClass(java.lang.String wrapperClass)
-
getWrapperSelector
public java.lang.String getWrapperSelector()
-
setWrapperSelector
public void setWrapperSelector(java.lang.String wrapperSelector)
-
getHelpTextI18nCode
public java.lang.String getHelpTextI18nCode()
-
getHelpBlockCode
public java.lang.String getHelpBlockCode()
Convenience method for binding data, seegetHelpTextI18nCode
-
setHelpTextI18nCode
public void setHelpTextI18nCode(java.lang.String helpTextI18nCode)
-
setHelpBlockCode
public void setHelpBlockCode(java.lang.String helpTextI18nCode)
Convenience method for binding data, seesetHelpTextI18nCode
-
getOptionSourceType
public java.lang.String getOptionSourceType()
-
setOptionSourceType
public void setOptionSourceType(java.lang.String optionSourceType)
-
getRequireOnCode
public java.lang.String getRequireOnCode()
-
setRequireOnCode
public void setRequireOnCode(java.lang.String requireOnCode)
-
getVisibleOnCode
public java.lang.String getVisibleOnCode()
-
setVisibleOnCode
public void setVisibleOnCode(java.lang.String visibleOnCode)
-
getVerifyPattern
public java.lang.String getVerifyPattern()
-
setVerifyPattern
public void setVerifyPattern(java.lang.String verifyPattern)
-
getFormat
public java.lang.String getFormat()
-
setFormat
public void setFormat(java.lang.String format)
-
getEvarName
public java.lang.String getEvarName()
-
setEvarName
public void setEvarName(java.lang.String evarName)
-
getConversionType
public java.lang.String getConversionType()
-
setConversionType
public void setConversionType(java.lang.String conversionType)
-
getViewTemplate
public java.lang.String getViewTemplate()
-
setViewTemplate
public void setViewTemplate(java.lang.String viewTemplate)
-
getEditTemplate
public java.lang.String getEditTemplate()
-
setEditTemplate
public void setEditTemplate(java.lang.String editTemplate)
-
getAddTemplate
public java.lang.String getAddTemplate()
-
setAddTemplate
public void setAddTemplate(java.lang.String addTemplate)
-
getIdTemplate
public java.lang.String getIdTemplate()
-
setIdTemplate
public void setIdTemplate(java.lang.String idTemplate)
-
getApiList
public java.lang.String getApiList()
-
setApiList
public void setApiList(java.lang.String apiList)
-
getOwnerEditable
public java.lang.Boolean getOwnerEditable()
-
setOwnerEditable
public void setOwnerEditable(java.lang.Boolean ownerEditable)
-
getTenantEditable
public java.lang.Boolean getTenantEditable()
-
setTenantEditable
public void setTenantEditable(java.lang.Boolean tenantEditable)
-
getTenantVisible
public java.lang.Boolean getTenantVisible()
-
setTenantVisible
public void setTenantVisible(java.lang.Boolean tenantVisible)
-
getCreatable
public java.lang.Boolean getCreatable()
-
setCreatable
public void setCreatable(java.lang.Boolean creatable)
-
getGlobal
public java.lang.Boolean getGlobal()
-
setGlobal
public void setGlobal(java.lang.Boolean global)
-
getCustom
public java.lang.Boolean getCustom()
-
setCustom
public void setCustom(java.lang.Boolean custom)
-
getAdvanced
public java.lang.Boolean getAdvanced()
-
setAdvanced
public void setAdvanced(java.lang.Boolean advanced)
-
getExportEvar
public java.lang.Boolean getExportEvar()
-
setExportEvar
public void setExportEvar(java.lang.Boolean exportEvar)
-
getExportMeta
public java.lang.Boolean getExportMeta()
-
setExportMeta
public void setExportMeta(java.lang.Boolean exportMeta)
-
getGroupExpand
public java.lang.Boolean getGroupExpand()
-
setGroupExpand
public void setGroupExpand(java.lang.Boolean groupExpand)
-
getNoBlank
public java.lang.Boolean getNoBlank()
-
setNoBlank
public void setNoBlank(java.lang.Boolean noBlank)
-
getContextualDefault
public java.lang.Boolean getContextualDefault()
-
setContextualDefault
public void setContextualDefault(java.lang.Boolean contextualDefault)
-
getSecretField
public java.lang.Boolean getSecretField()
-
setSecretField
public void setSecretField(java.lang.Boolean secretField)
-
getExcludeFromSearch
public java.lang.Boolean getExcludeFromSearch()
-
setExcludeFromSearch
public void setExcludeFromSearch(java.lang.Boolean excludeFromSearch)
-
getIgnoreField
public java.lang.Boolean getIgnoreField()
-
setIgnoreField
public void setIgnoreField(java.lang.Boolean ignoreField)
-
getMultiTenant
public java.lang.Boolean getMultiTenant()
-
setMultiTenant
public void setMultiTenant(java.lang.Boolean multiTenant)
-
-