Class InputDetail


  • public class InputDetail
    extends Object
    InputDetail
    • Constructor Detail

      • InputDetail

        public InputDetail()
    • Method Detail

      • configuration

        public InputDetail configuration​(Map<String,​String> configuration)
        Configuration parameters for the required input.
        Parameters:
        configuration - Configuration parameters for the required input.
        Returns:
        the current InputDetail instance, allowing for method chaining
      • getConfiguration

        public Map<String,​String> getConfiguration()
        Configuration parameters for the required input.
        Returns:
        configuration Configuration parameters for the required input.
      • setConfiguration

        public void setConfiguration​(Map<String,​String> configuration)
        Configuration parameters for the required input.
        Parameters:
        configuration - Configuration parameters for the required input.
      • details

        public InputDetail details​(List<SubInputDetail> details)
        Input details can also be provided recursively.
        Parameters:
        details - Input details can also be provided recursively.
        Returns:
        the current InputDetail instance, allowing for method chaining
      • getDetails

        public List<SubInputDetail> getDetails()
        Input details can also be provided recursively.
        Returns:
        details Input details can also be provided recursively.
      • setDetails

        public void setDetails​(List<SubInputDetail> details)
        Input details can also be provided recursively.
        Parameters:
        details - Input details can also be provided recursively.
      • inputDetails

        @Deprecated
        public InputDetail inputDetails​(List<SubInputDetail> inputDetails)
        Deprecated.
        Input details can also be provided recursively (deprecated).
        Parameters:
        inputDetails - Input details can also be provided recursively (deprecated).
        Returns:
        the current InputDetail instance, allowing for method chaining
      • getInputDetails

        @Deprecated
        public List<SubInputDetail> getInputDetails()
        Deprecated.
        // deprecated
        Input details can also be provided recursively (deprecated).
        Returns:
        inputDetails Input details can also be provided recursively (deprecated).
      • setInputDetails

        @Deprecated
        public void setInputDetails​(List<SubInputDetail> inputDetails)
        Deprecated.
        Input details can also be provided recursively (deprecated).
        Parameters:
        inputDetails - Input details can also be provided recursively (deprecated).
      • itemSearchUrl

        public InputDetail itemSearchUrl​(String itemSearchUrl)
        In case of a select, the URL from which to query the items.
        Parameters:
        itemSearchUrl - In case of a select, the URL from which to query the items.
        Returns:
        the current InputDetail instance, allowing for method chaining
      • getItemSearchUrl

        public String getItemSearchUrl()
        In case of a select, the URL from which to query the items.
        Returns:
        itemSearchUrl In case of a select, the URL from which to query the items.
      • setItemSearchUrl

        public void setItemSearchUrl​(String itemSearchUrl)
        In case of a select, the URL from which to query the items.
        Parameters:
        itemSearchUrl - In case of a select, the URL from which to query the items.
      • items

        public InputDetail items​(List<Item> items)
        In case of a select, the items to choose from.
        Parameters:
        items - In case of a select, the items to choose from.
        Returns:
        the current InputDetail instance, allowing for method chaining
      • getItems

        public List<Item> getItems()
        In case of a select, the items to choose from.
        Returns:
        items In case of a select, the items to choose from.
      • setItems

        public void setItems​(List<Item> items)
        In case of a select, the items to choose from.
        Parameters:
        items - In case of a select, the items to choose from.
      • key

        public InputDetail key​(String key)
        The value to provide in the result.
        Parameters:
        key - The value to provide in the result.
        Returns:
        the current InputDetail instance, allowing for method chaining
      • getKey

        public String getKey()
        The value to provide in the result.
        Returns:
        key The value to provide in the result.
      • setKey

        public void setKey​(String key)
        The value to provide in the result.
        Parameters:
        key - The value to provide in the result.
      • optional

        public InputDetail optional​(Boolean optional)
        True if this input value is optional.
        Parameters:
        optional - True if this input value is optional.
        Returns:
        the current InputDetail instance, allowing for method chaining
      • getOptional

        public Boolean getOptional()
        True if this input value is optional.
        Returns:
        optional True if this input value is optional.
      • setOptional

        public void setOptional​(Boolean optional)
        True if this input value is optional.
        Parameters:
        optional - True if this input value is optional.
      • type

        public InputDetail type​(String type)
        The type of the required input.
        Parameters:
        type - The type of the required input.
        Returns:
        the current InputDetail instance, allowing for method chaining
      • getType

        public String getType()
        The type of the required input.
        Returns:
        type The type of the required input.
      • setType

        public void setType​(String type)
        The type of the required input.
        Parameters:
        type - The type of the required input.
      • value

        public InputDetail value​(String value)
        The value can be pre-filled, if available.
        Parameters:
        value - The value can be pre-filled, if available.
        Returns:
        the current InputDetail instance, allowing for method chaining
      • getValue

        public String getValue()
        The value can be pre-filled, if available.
        Returns:
        value The value can be pre-filled, if available.
      • setValue

        public void setValue​(String value)
        The value can be pre-filled, if available.
        Parameters:
        value - The value can be pre-filled, if available.
      • includeNullValues

        public InputDetail includeNullValues​(boolean includeNullValues)
        Configures whether null values are explicitly serialized in the JSON payload. Default is false.
      • isIncludeNullValues

        public boolean isIncludeNullValues()
        Returns whether null values are explicitly serialized in the JSON payload.
      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)
        Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
      • equals

        public boolean equals​(Object o)
        Return true if this InputDetail object is equal to o.
        Overrides:
        equals in class Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • getExplicitNulls

        public Map<String,​Object> getExplicitNulls()
        Returns a map of properties to be merged into the JSON payload as explicit null values.
      • fromJson

        public static InputDetail fromJson​(String jsonString)
                                    throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of InputDetail given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of InputDetail
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to InputDetail
      • toJson

        public String toJson()
                      throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of InputDetail to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException