Class CustomPropertiesFieldConfig
- java.lang.Object
-
- com.boomi.connector.api.ui.CustomPropertiesFieldConfig
-
- All Implemented Interfaces:
Serializable
public class CustomPropertiesFieldConfig extends Object implements Serializable
Java class for CustomPropertiesFieldConfig complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="CustomPropertiesFieldConfig"> <complexContent> <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> <sequence> <element name="blacklistedKey" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/> <element name="restrictedKey" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/> </sequence> <attribute name="keyLabel" type="{http://www.w3.org/2001/XMLSchema}anySimpleType" default="Key" /> <attribute name="valueLabel" type="{http://www.w3.org/2001/XMLSchema}anySimpleType" default="Value" /> <attribute name="addButtonLabel" type="{http://www.w3.org/2001/XMLSchema}anySimpleType" default="Add Property" /> <attribute name="allowValueEncryption" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" /> </restriction> </complexContent> </complexType>- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected StringaddButtonLabelprotected BooleanallowValueEncryptionprotected List<String>blacklistedKeysstatic CustomPropertiesFieldConfigEMPTY_INSTANCEprotected StringkeyLabelprotected List<String>restrictedKeysprotected StringvalueLabel
-
Constructor Summary
Constructors Constructor Description CustomPropertiesFieldConfig()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CustomPropertiesFieldConfigcopy()Deep copies the fields of the this model into a new instance of this class and returns it.CustomPropertiesFieldConfigcopy(boolean isDeep)Copies the fields of the this model (optionally deeply) into a new instance of this class and returns it.protected CustomPropertiesFieldConfigcopy(CustomPropertiesFieldConfig nobj, boolean isDeep)Copies the fields of the this model (optionally deeply) into the given instance and returns it.booleanequals(Object o)StringgetAddButtonLabel()Optional button label to be displayed on the custom properties table in order to add The label should at least have a non-blank character.List<String>getBlacklistedKeys()This has been deprecated in favor of restrictedKeys.StringgetKeyLabel()Optional custom header label for the key column in the custom properties table.List<String>getRestrictedKeys()Optional set of restricted keys for Custom Properties DataType.StringgetValueLabel()Optional custom header label for the value column in the custom properties table.inthashCode()booleanisAllowValueEncryption()Optional setting to enable/disable encryption on the custom properties table.voidsetAddButtonLabel(String value)Sets the value of the addButtonLabel property.voidsetAllowValueEncryption(Boolean value)Sets the value of the allowValueEncryption property.voidsetKeyLabel(String value)Sets the value of the keyLabel property.voidsetValueLabel(String value)Sets the value of the valueLabel property.StringtoString()CustomPropertiesFieldConfigwithAddButtonLabel(String newValue)Sets the addButtonLabel property to the given newValue and returns this instance.CustomPropertiesFieldConfigwithAllowValueEncryption(Boolean newValue)Sets the allowValueEncryption property to the given newValue and returns this instance.CustomPropertiesFieldConfigwithBlacklistedKeys(String... newValues)Adds the given newValues to the current blacklistedKeys property List and returns this instance.CustomPropertiesFieldConfigwithBlacklistedKeys(Collection<? extends String> newValues)Adds the given newValues to the current blacklistedKeys property List and returns this instance.CustomPropertiesFieldConfigwithKeyLabel(String newValue)Sets the keyLabel property to the given newValue and returns this instance.CustomPropertiesFieldConfigwithRestrictedKeys(String... newValues)Adds the given newValues to the current restrictedKeys property List and returns this instance.CustomPropertiesFieldConfigwithRestrictedKeys(Collection<? extends String> newValues)Adds the given newValues to the current restrictedKeys property List and returns this instance.CustomPropertiesFieldConfigwithValueLabel(String newValue)Sets the valueLabel property to the given newValue and returns this instance.
-
-
-
Field Detail
-
keyLabel
protected String keyLabel
-
valueLabel
protected String valueLabel
-
addButtonLabel
protected String addButtonLabel
-
allowValueEncryption
protected Boolean allowValueEncryption
-
EMPTY_INSTANCE
public static final CustomPropertiesFieldConfig EMPTY_INSTANCE
-
-
Method Detail
-
getBlacklistedKeys
public List<String> getBlacklistedKeys()
This has been deprecated in favor of restrictedKeys. Optional set of restricted keys for Custom Properties DataType. The keys listed here are case insensitive. Gets the value of the blacklistedKeys property.This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
setmethod for the blacklistedKeys property.For example, to add a new item, do as follows:
getBlacklistedKeys().add(newItem);Objects of the following type(s) are allowed in the list
String
-
getRestrictedKeys
public List<String> getRestrictedKeys()
Optional set of restricted keys for Custom Properties DataType. The keys listed here are case insensitive. Gets the value of the restrictedKeys property.This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
setmethod for the restrictedKeys property.For example, to add a new item, do as follows:
getRestrictedKeys().add(newItem);Objects of the following type(s) are allowed in the list
String
-
getKeyLabel
public String getKeyLabel()
Optional custom header label for the key column in the custom properties table. The label should have a non-blank character. The maximum length of this label can be 25 characters. If not specified, will default to 'Key'.- Returns:
- possible object is
String
-
setKeyLabel
public void setKeyLabel(String value)
Sets the value of the keyLabel property.- Parameters:
value- allowed object isString
-
getValueLabel
public String getValueLabel()
Optional custom header label for the value column in the custom properties table. The label should at least have a non-blank character. The maximum length of this label can be 25 characters. If not specified, will default to 'Value'.- Returns:
- possible object is
String
-
setValueLabel
public void setValueLabel(String value)
Sets the value of the valueLabel property.- Parameters:
value- allowed object isString
-
getAddButtonLabel
public String getAddButtonLabel()
Optional button label to be displayed on the custom properties table in order to add The label should at least have a non-blank character. The maximum length of the label can be 12 characters. a new custom property. By default, this will be 'Add Property'- Returns:
- possible object is
String
-
setAddButtonLabel
public void setAddButtonLabel(String value)
Sets the value of the addButtonLabel property.- Parameters:
value- allowed object isString
-
isAllowValueEncryption
public boolean isAllowValueEncryption()
Optional setting to enable/disable encryption on the custom properties table. By default, this will be enabled.- Returns:
- possible object is
Boolean
-
setAllowValueEncryption
public void setAllowValueEncryption(Boolean value)
Sets the value of the allowValueEncryption property.- Parameters:
value- allowed object isBoolean
-
copy
public CustomPropertiesFieldConfig copy()
Deep copies the fields of the this model into a new instance of this class and returns it.
-
copy
public CustomPropertiesFieldConfig copy(boolean isDeep)
Copies the fields of the this model (optionally deeply) into a new instance of this class and returns it.
-
copy
protected CustomPropertiesFieldConfig copy(CustomPropertiesFieldConfig nobj, boolean isDeep)
Copies the fields of the this model (optionally deeply) into the given instance and returns it.
-
withBlacklistedKeys
public CustomPropertiesFieldConfig withBlacklistedKeys(String... newValues)
Adds the given newValues to the current blacklistedKeys property List and returns this instance.
-
withBlacklistedKeys
public CustomPropertiesFieldConfig withBlacklistedKeys(Collection<? extends String> newValues)
Adds the given newValues to the current blacklistedKeys property List and returns this instance.
-
withRestrictedKeys
public CustomPropertiesFieldConfig withRestrictedKeys(String... newValues)
Adds the given newValues to the current restrictedKeys property List and returns this instance.
-
withRestrictedKeys
public CustomPropertiesFieldConfig withRestrictedKeys(Collection<? extends String> newValues)
Adds the given newValues to the current restrictedKeys property List and returns this instance.
-
withKeyLabel
public CustomPropertiesFieldConfig withKeyLabel(String newValue)
Sets the keyLabel property to the given newValue and returns this instance.
-
withValueLabel
public CustomPropertiesFieldConfig withValueLabel(String newValue)
Sets the valueLabel property to the given newValue and returns this instance.
-
withAddButtonLabel
public CustomPropertiesFieldConfig withAddButtonLabel(String newValue)
Sets the addButtonLabel property to the given newValue and returns this instance.
-
withAllowValueEncryption
public CustomPropertiesFieldConfig withAllowValueEncryption(Boolean newValue)
Sets the allowValueEncryption property to the given newValue and returns this instance.
-
-