BrowseField

java.lang.Object
- com.boomi.connector.api.ui.BrowseField

All Implemented Interfaces:: Serializable

public class BrowseField
extends Object
implements Serializable

Common specification for a field of information necessary in when working with a connector.

Java class for BrowseField complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="BrowseField">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="helpText" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="defaultValue" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="allowedValue" type="{http://www.boomi.com/connector/api/ui}AllowedValue" maxOccurs="unbounded" minOccurs="0"/>
         <element name="customPropertiesConfiguration" type="{http://www.boomi.com/connector/api/ui}CustomPropertiesFieldConfig" minOccurs="0"/>
         <element name="visibilityCondition" type="{http://www.boomi.com/connector/api/ui}VisibilityCondition" maxOccurs="10" minOccurs="0"/>
       </sequence>
       <attribute name="id" use="required" type="{http://www.w3.org/2001/XMLSchema}NCName" />
       <attribute name="label" type="{http://www.w3.org/2001/XMLSchema}normalizedString" />
       <attribute name="type" use="required" type="{http://www.boomi.com/connector/api/ui}DataType" />
       <attribute name="displayType" type="{http://www.boomi.com/connector/api/ui}DisplayType" default="list" />
       <attribute name="overrideable" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
     </restriction>
   </complexContent>
 </complexType>

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<AllowedValue>`	`allowedValues`
`protected CustomPropertiesFieldConfig`	`customPropertiesConfiguration`
`protected String`	`defaultValue`
`protected DisplayType`	`displayType`
`static BrowseField`	`EMPTY_INSTANCE`
`protected String`	`helpText`
`protected String`	`id`
`protected String`	`label`
`protected Boolean`	`overrideable`
`protected DataType`	`type`
`protected List<VisibilityCondition>`	`visibilityConditions`

Constructor Summary

Constructors
Constructor and Description

BrowseField()

Constructors
Constructor and Description
`BrowseField()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BrowseField`	`copy()` Deep copies the fields of the this model into a new instance of this class and returns it.
`BrowseField`	`copy(boolean isDeep)` Copies the fields of the this model (optionally deeply) into a new instance of this class and returns it.
`protected BrowseField`	`copy(BrowseField nobj, boolean isDeep)` Copies the fields of the this model (optionally deeply) into the given instance and returns it.
`boolean`	`equals(Object o)`
`List<AllowedValue>`	`getAllowedValues()` Optional set of allowed values for this field.
`CustomPropertiesFieldConfig`	`getCustomPropertiesConfiguration()` Configuration of the key value pairs for a field.
`String`	`getDefaultValue()` Optional default value for this field presented to the user in the GUI.
`DisplayType`	`getDisplayType()` The type of UI element to use when displaying the field
`String`	`getHelpText()` Optional help text displayed for the field in the GUI.
`String`	`getId()` The actual name of the field which will be passed as the property key to the connector.
`String`	`getLabel()` Optional text string which will be displayed in the GUI for this field.
`DataType`	`getType()` The type of the property value which will be passed to the connector.
`List<VisibilityCondition>`	`getVisibilityConditions()` Configuration of a rule that controls the visibility of the current field based on the value of another field within the same screen.
`int`	`hashCode()`
`boolean`	`isOverrideable()` When specified as true, this attribute will allow the operation field to be overriden on the process level.
`CustomPropertiesFieldConfig`	`safeGetCustomPropertiesConfiguration()` Returns the current customPropertiesConfiguration property value if non-`null`, otherwise `CustomPropertiesFieldConfig.EMPTY_INSTANCE`.
`void`	`setCustomPropertiesConfiguration(CustomPropertiesFieldConfig value)` Sets the value of the customPropertiesConfiguration property.
`void`	`setDefaultValue(String value)` Sets the value of the defaultValue property.
`void`	`setDisplayType(DisplayType value)` Sets the value of the displayType property.
`void`	`setHelpText(String value)` Sets the value of the helpText property.
`void`	`setId(String value)` Sets the value of the id property.
`void`	`setLabel(String value)` Sets the value of the label property.
`void`	`setOverrideable(Boolean value)` Sets the value of the overrideable property.
`void`	`setType(DataType value)` Sets the value of the type property.
`String`	`toString()`
`BrowseField`	`withAllowedValues(AllowedValue... newValues)` Adds the given newValues to the current allowedValues property List and returns this instance.
`BrowseField`	`withAllowedValues(Collection<? extends AllowedValue> newValues)` Adds the given newValues to the current allowedValues property List and returns this instance.
`BrowseField`	`withCustomPropertiesConfiguration(CustomPropertiesFieldConfig newValue)` Sets the customPropertiesConfiguration property to the given newValue and returns this instance.
`BrowseField`	`withDefaultValue(String newValue)` Sets the defaultValue property to the given newValue and returns this instance.
`BrowseField`	`withDisplayType(DisplayType newValue)` Sets the displayType property to the given newValue and returns this instance.
`BrowseField`	`withHelpText(String newValue)` Sets the helpText property to the given newValue and returns this instance.
`BrowseField`	`withId(String newValue)` Sets the id property to the given newValue and returns this instance.
`BrowseField`	`withLabel(String newValue)` Sets the label property to the given newValue and returns this instance.
`BrowseField`	`withOverrideable(Boolean newValue)` Sets the overrideable property to the given newValue and returns this instance.
`BrowseField`	`withType(DataType newValue)` Sets the type property to the given newValue and returns this instance.
`BrowseField`	`withVisibilityConditions(Collection<? extends VisibilityCondition> newValues)` Adds the given newValues to the current visibilityConditions property List and returns this instance.
`BrowseField`	`withVisibilityConditions(VisibilityCondition... newValues)` Adds the given newValues to the current visibilityConditions property List and returns this instance.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - helpText
```
protected String helpText
```
  - defaultValue
```
protected String defaultValue
```
  - allowedValues
```
protected List<AllowedValue> allowedValues
```
  - customPropertiesConfiguration
```
protected CustomPropertiesFieldConfig customPropertiesConfiguration
```
  - visibilityConditions
```
protected List<VisibilityCondition> visibilityConditions
```
  - id
```
protected String id
```
  - label
```
protected String label
```
  - type
```
protected DataType type
```
  - displayType
```
protected DisplayType displayType
```
  - overrideable
```
protected Boolean overrideable
```
  - EMPTY_INSTANCE
```
public static final BrowseField EMPTY_INSTANCE
```
- Constructor Detail
  - BrowseField
```
public BrowseField()
```
- Method Detail
  - getHelpText
```
public String getHelpText()
```
    Optional help text displayed for the field in the GUI.
    
    Returns:
    
    possible object is String
  - setHelpText
```
public void setHelpText(String value)
```
    Sets the value of the helpText property.
    
    Parameters:
    
    value - allowed object is String
  - getDefaultValue
```
public String getDefaultValue()
```
    Optional default value for this field presented to the user in the GUI. This value must be valid for the data type.
    
    Returns:
    
    possible object is String
  - setDefaultValue
```
public void setDefaultValue(String value)
```
    Sets the value of the defaultValue property.
    
    Parameters:
    
    value - allowed object is String
  - getAllowedValues
```
public List<AllowedValue> getAllowedValues()
```
    Optional set of allowed values for this field. If specified, GUI selection will be restricted to one of these values. These values must be valid for the data type.
    Gets the value of the allowedValues 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 allowedValues property.
    For example, to add a new item, do as follows:
```
    getAllowedValues().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list AllowedValue
  - getCustomPropertiesConfiguration
```
public CustomPropertiesFieldConfig getCustomPropertiesConfiguration()
```
    Configuration of the key value pairs for a field.
    
    Returns:
    
    possible object is CustomPropertiesFieldConfig
  - setCustomPropertiesConfiguration
```
public void setCustomPropertiesConfiguration(CustomPropertiesFieldConfig value)
```
    Sets the value of the customPropertiesConfiguration property.
    
    Parameters:
    
    value - allowed object is CustomPropertiesFieldConfig
  - getVisibilityConditions
```
public List<VisibilityCondition> getVisibilityConditions()
```
    Configuration of a rule that controls the visibility of the current field based on the value of another field within the same screen. Currently there is a limit of 1 visibility condition.Gets the value of the visibilityConditions 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 visibilityConditions property.
    For example, to add a new item, do as follows:
```
    getVisibilityConditions().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list VisibilityCondition
  - getId
```
public String getId()
```
    The actual name of the field which will be passed as the property key to the connector.
    
    Returns:
    
    possible object is String
  - setId
```
public void setId(String value)
```
    Sets the value of the id property.
    
    Parameters:
    
    value - allowed object is String
  - getLabel
```
public String getLabel()
```
    Optional text string which will be displayed in the GUI for this field. If not defined, the id will be used.
    
    Returns:
    
    possible object is String
  - setLabel
```
public void setLabel(String value)
```
    Sets the value of the label property.
    
    Parameters:
    
    value - allowed object is String
  - getType
```
public DataType getType()
```
    The type of the property value which will be passed to the connector. This will also restrict what values may be entered in the GUI.
    
    Returns:
    
    possible object is DataType
  - setType
```
public void setType(DataType value)
```
    Sets the value of the type property.
    
    Parameters:
    
    value - allowed object is DataType
  - getDisplayType
```
public DisplayType getDisplayType()
```
    The type of UI element to use when displaying the field
    
    Returns:
    
    possible object is DisplayType
  - setDisplayType
```
public void setDisplayType(DisplayType value)
```
    Sets the value of the displayType property.
    
    Parameters:
    
    value - allowed object is DisplayType
  - isOverrideable
```
public boolean isOverrideable()
```
    When specified as true, this attribute will allow the operation field to be overriden on the process level.
    
    Returns:
    
    possible object is Boolean
  - setOverrideable
```
public void setOverrideable(Boolean value)
```
    Sets the value of the overrideable property.
    
    Parameters:
    
    value - allowed object is Boolean
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - copy
```
public BrowseField copy()
```
    Deep copies the fields of the this model into a new instance of this class and returns it.
  - copy
```
public BrowseField copy(boolean isDeep)
```
    Copies the fields of the this model (optionally deeply) into a new instance of this class and returns it.
  - copy
```
protected BrowseField copy(BrowseField nobj,
                           boolean isDeep)
```
    Copies the fields of the this model (optionally deeply) into the given instance and returns it.
  - withHelpText
```
public BrowseField withHelpText(String newValue)
```
    Sets the helpText property to the given newValue and returns this instance.
  - withDefaultValue
```
public BrowseField withDefaultValue(String newValue)
```
    Sets the defaultValue property to the given newValue and returns this instance.
  - withAllowedValues
```
public BrowseField withAllowedValues(AllowedValue... newValues)
```
    Adds the given newValues to the current allowedValues property List and returns this instance.
  - withAllowedValues
```
public BrowseField withAllowedValues(Collection<? extends AllowedValue> newValues)
```
    Adds the given newValues to the current allowedValues property List and returns this instance.
  - withCustomPropertiesConfiguration
```
public BrowseField withCustomPropertiesConfiguration(CustomPropertiesFieldConfig newValue)
```
    Sets the customPropertiesConfiguration property to the given newValue and returns this instance.
  - safeGetCustomPropertiesConfiguration
```
public CustomPropertiesFieldConfig safeGetCustomPropertiesConfiguration()
```
    Returns the current customPropertiesConfiguration property value if non-null, otherwise CustomPropertiesFieldConfig.EMPTY_INSTANCE.
  - withVisibilityConditions
```
public BrowseField withVisibilityConditions(VisibilityCondition... newValues)
```
    Adds the given newValues to the current visibilityConditions property List and returns this instance.
  - withVisibilityConditions
```
public BrowseField withVisibilityConditions(Collection<? extends VisibilityCondition> newValues)
```
    Adds the given newValues to the current visibilityConditions property List and returns this instance.
  - withId
```
public BrowseField withId(String newValue)
```
    Sets the id property to the given newValue and returns this instance.
  - withLabel
```
public BrowseField withLabel(String newValue)
```
    Sets the label property to the given newValue and returns this instance.
  - withType
```
public BrowseField withType(DataType newValue)
```
    Sets the type property to the given newValue and returns this instance.
  - withDisplayType
```
public BrowseField withDisplayType(DisplayType newValue)
```
    Sets the displayType property to the given newValue and returns this instance.
  - withOverrideable
```
public BrowseField withOverrideable(Boolean newValue)
```
    Sets the overrideable property to the given newValue and returns this instance.

Class BrowseField

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

helpText

defaultValue

allowedValues

customPropertiesConfiguration

visibilityConditions

id

label

type

displayType

overrideable

EMPTY_INSTANCE

Constructor Detail

BrowseField

Method Detail

getHelpText

setHelpText

getDefaultValue

setDefaultValue

getAllowedValues

getCustomPropertiesConfiguration

setCustomPropertiesConfiguration

getVisibilityConditions

getId

setId

getLabel

setLabel

getType

setType

getDisplayType

setDisplayType

isOverrideable

setOverrideable

hashCode

toString

equals

copy

copy

copy

withHelpText

withDefaultValue

withAllowedValues

withAllowedValues

withCustomPropertiesConfiguration

safeGetCustomPropertiesConfiguration

withVisibilityConditions

withVisibilityConditions

withId

withLabel

withType

withDisplayType

withOverrideable