Package net.avalara.avatax.rest.client.models

Class ParameterModel

java.lang.Object
net.avalara.avatax.rest.client.models.ParameterModel
public class ParameterModel extends Object
An extra property that can change the behavior of tax transactions.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ParameterModel()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAttributeSubType()
    Getter for attributeSubType The sub-type of parameter as determined by its application.
    String
    getAttributeType()
    Getter for attributeType The type of parameter as determined by its application, e.g.
    String
    getCategory()
    Getter for category DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null.
    String
    getDataType()
    Getter for dataType The data type of the property.
    String
    getHelpText()
    Getter for helpText Help text to be shown to the user when they are filling out this parameter.
    String
    getHelpUrl()
    Getter for helpUrl A help url that provides more information about the parameter
    Long
    getId()
    Getter for id The unique ID number of this property.
    Boolean
    getIsNeededForCalculation()
    Getter for isNeededForCalculation This field identifies if parameter is needed for calculation
    Boolean
    getIsNeededForClassification()
    Getter for isNeededForClassification This field identifies if parameter is needed for classification
    Boolean
    getIsNeededForReturns()
    Getter for isNeededForReturns This field identifies if parameter is needed for returns
    String
    getLabel()
    Getter for label Label that helps the user to identify a parameter
    String
    getMeasurementType()
    Getter for measurementType The unit of measurement type of the parameter
    String
    getName()
    Getter for name The name of the property.
    String
    getPrompt()
    Getter for prompt DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null.
    String
    getRegularExpression()
    Getter for regularExpression DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null.
    ArrayList<String>
    getServiceTypes()
    Getter for serviceTypes A list of service types to which this parameter applies.
    ArrayList<String>
    getValues()
    Getter for values If the parameter is of enumeration data type, then this list will be populated with all of the possible enumeration values.
    void
    setAttributeSubType(String value)
    Setter for attributeSubType The sub-type of parameter as determined by its application.
    void
    setAttributeType(String value)
    Setter for attributeType The type of parameter as determined by its application, e.g.
    void
    setCategory(String value)
    Setter for category DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null.
    void
    setDataType(String value)
    Setter for dataType The data type of the property.
    void
    setHelpText(String value)
    Setter for helpText Help text to be shown to the user when they are filling out this parameter.
    void
    setHelpUrl(String value)
    Setter for helpUrl A help url that provides more information about the parameter
    void
    setId(Long value)
    Setter for id The unique ID number of this property.
    void
    setIsNeededForCalculation(Boolean value)
    Setter for isNeededForCalculation This field identifies if parameter is needed for calculation
    void
    setIsNeededForClassification(Boolean value)
    Setter for isNeededForClassification This field identifies if parameter is needed for classification
    void
    setIsNeededForReturns(Boolean value)
    Setter for isNeededForReturns This field identifies if parameter is needed for returns
    void
    setLabel(String value)
    Setter for label Label that helps the user to identify a parameter
    void
    setMeasurementType(String value)
    Setter for measurementType The unit of measurement type of the parameter
    void
    setName(String value)
    Setter for name The name of the property.
    void
    setPrompt(String value)
    Setter for prompt DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null.
    void
    setRegularExpression(String value)
    Setter for regularExpression DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null.
    void
    setServiceTypes(ArrayList<String> value)
    Setter for serviceTypes A list of service types to which this parameter applies.
    void
    setValues(ArrayList<String> value)
    Setter for values If the parameter is of enumeration data type, then this list will be populated with all of the possible enumeration values.
    String
    toString()
    Returns a JSON string representation of ParameterModel

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ParameterModel

      public ParameterModel()

  • Method Details

    • getId

      public Long getId()
      Getter for id The unique ID number of this property.

    • setId

      public void setId(Long value)
      Setter for id The unique ID number of this property.

    • getCategory

      public String getCategory()
      Getter for category DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null. The category grouping of this parameter. When your user interface displays a large number of parameters, they should be grouped by their category value.

    • setCategory

      public void setCategory(String value)
      Setter for category DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null. The category grouping of this parameter. When your user interface displays a large number of parameters, they should be grouped by their category value.

    • getName

      public String getName()
      Getter for name The name of the property. To use this property, add a field on the `parameters` object of a [CreateTransaction](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/) call.

    • setName

      public void setName(String value)
      Setter for name The name of the property. To use this property, add a field on the `parameters` object of a [CreateTransaction](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Transactions/CreateTransaction/) call.

    • getDataType

      public String getDataType()
      Getter for dataType The data type of the property.

    • setDataType

      public void setDataType(String value)
      Setter for dataType The data type of the property.

    • getHelpText

      public String getHelpText()
      Getter for helpText Help text to be shown to the user when they are filling out this parameter. Help text may include HTML links to additional content with more information about a parameter.

    • setHelpText

      public void setHelpText(String value)
      Setter for helpText Help text to be shown to the user when they are filling out this parameter. Help text may include HTML links to additional content with more information about a parameter.

    • getServiceTypes

      public ArrayList<String> getServiceTypes()
      Getter for serviceTypes A list of service types to which this parameter applies.

    • setServiceTypes

      public void setServiceTypes(ArrayList<String> value)
      Setter for serviceTypes A list of service types to which this parameter applies.

    • getPrompt

      public String getPrompt()
      Getter for prompt DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null. The prompt you should use when displaying this parameter to a user. For example, if your user interface displays a parameter in a text box, this is the label you should use to identify that text box.

    • setPrompt

      public void setPrompt(String value)
      Setter for prompt DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null. The prompt you should use when displaying this parameter to a user. For example, if your user interface displays a parameter in a text box, this is the label you should use to identify that text box.

    • getRegularExpression

      public String getRegularExpression()
      Getter for regularExpression DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null. If your user interface permits client-side validation of parameters, this string is a regular expression you can use to validate the user's data entry prior to submitting a tax request.

    • setRegularExpression

      public void setRegularExpression(String value)
      Setter for regularExpression DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null. If your user interface permits client-side validation of parameters, this string is a regular expression you can use to validate the user's data entry prior to submitting a tax request.

    • getLabel

      public String getLabel()
      Getter for label Label that helps the user to identify a parameter

    • setLabel

      public void setLabel(String value)
      Setter for label Label that helps the user to identify a parameter

    • getHelpUrl

      public String getHelpUrl()
      Getter for helpUrl A help url that provides more information about the parameter

    • setHelpUrl

      public void setHelpUrl(String value)
      Setter for helpUrl A help url that provides more information about the parameter

    • getAttributeType

      public String getAttributeType()
      Getter for attributeType The type of parameter as determined by its application, e.g. Product, Transaction, Calculated

    • setAttributeType

      public void setAttributeType(String value)
      Setter for attributeType The type of parameter as determined by its application, e.g. Product, Transaction, Calculated

    • getAttributeSubType

      public String getAttributeSubType()
      Getter for attributeSubType The sub-type of parameter as determined by its application.

    • setAttributeSubType

      public void setAttributeSubType(String value)
      Setter for attributeSubType The sub-type of parameter as determined by its application.

    • getValues

      public ArrayList<String> getValues()
      Getter for values If the parameter is of enumeration data type, then this list will be populated with all of the possible enumeration values.

    • setValues

      public void setValues(ArrayList<String> value)
      Setter for values If the parameter is of enumeration data type, then this list will be populated with all of the possible enumeration values.

    • getMeasurementType

      public String getMeasurementType()
      Getter for measurementType The unit of measurement type of the parameter

    • setMeasurementType

      public void setMeasurementType(String value)
      Setter for measurementType The unit of measurement type of the parameter

    • getIsNeededForCalculation

      public Boolean getIsNeededForCalculation()
      Getter for isNeededForCalculation This field identifies if parameter is needed for calculation

    • setIsNeededForCalculation

      public void setIsNeededForCalculation(Boolean value)
      Setter for isNeededForCalculation This field identifies if parameter is needed for calculation

    • getIsNeededForReturns

      public Boolean getIsNeededForReturns()
      Getter for isNeededForReturns This field identifies if parameter is needed for returns

    • setIsNeededForReturns

      public void setIsNeededForReturns(Boolean value)
      Setter for isNeededForReturns This field identifies if parameter is needed for returns

    • getIsNeededForClassification

      public Boolean getIsNeededForClassification()
      Getter for isNeededForClassification This field identifies if parameter is needed for classification

    • setIsNeededForClassification

      public void setIsNeededForClassification(Boolean value)
      Setter for isNeededForClassification This field identifies if parameter is needed for classification

    • toString

      public String toString()
      Returns a JSON string representation of ParameterModel
      Overrides:
      toString in class Object