Class 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
    • Constructor Detail

      • CustomPropertiesFieldConfig

        public CustomPropertiesFieldConfig()
    • 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 set method 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 set method 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 is String
      • 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 is String
      • 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 is String
      • 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 is Boolean
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • 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.
      • 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.
      • 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.