Class ParameterModel
- java.lang.Object
-
- net.avalara.avatax.rest.client.models.ParameterModel
-
public class ParameterModel extends java.lang.ObjectAn extra property that can change the behavior of tax transactions.
-
-
Constructor Summary
Constructors Constructor Description ParameterModel()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.StringgetAttributeType()Getter for attributeType The type of parameter as determined by its application, e.g.java.lang.StringgetCategory()Getter for category DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null.java.lang.StringgetDataType()Getter for dataType The data type of the property.java.lang.StringgetHelpText()Getter for helpText Help text to be shown to the user when they are filling out this parameter.java.lang.StringgetHelpUrl()Getter for helpUrl A help url that provides more information about the parameterjava.lang.LonggetId()Getter for id The unique ID number of this property.java.lang.StringgetLabel()Getter for label Label that helps the user to identify a parameterjava.lang.StringgetMeasurementType()Getter for measurementType The unit of measurement type of the parameterjava.lang.StringgetName()Getter for name The name of the property.java.lang.StringgetPrompt()Getter for prompt DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null.java.lang.StringgetRegularExpression()Getter for regularExpression DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null.java.util.ArrayList<java.lang.String>getServiceTypes()Getter for serviceTypes A list of service types to which this parameter applies.java.util.ArrayList<java.lang.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.voidsetAttributeType(java.lang.String value)Setter for attributeType The type of parameter as determined by its application, e.g.voidsetCategory(java.lang.String value)Setter for category DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null.voidsetDataType(java.lang.String value)Setter for dataType The data type of the property.voidsetHelpText(java.lang.String value)Setter for helpText Help text to be shown to the user when they are filling out this parameter.voidsetHelpUrl(java.lang.String value)Setter for helpUrl A help url that provides more information about the parametervoidsetId(java.lang.Long value)Setter for id The unique ID number of this property.voidsetLabel(java.lang.String value)Setter for label Label that helps the user to identify a parametervoidsetMeasurementType(java.lang.String value)Setter for measurementType The unit of measurement type of the parametervoidsetName(java.lang.String value)Setter for name The name of the property.voidsetPrompt(java.lang.String value)Setter for prompt DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null.voidsetRegularExpression(java.lang.String value)Setter for regularExpression DEPRECATED - Date: 07/25/2018, Version: 18.7, Message: This field is deprecated and will return null.voidsetServiceTypes(java.util.ArrayList<java.lang.String> value)Setter for serviceTypes A list of service types to which this parameter applies.voidsetValues(java.util.ArrayList<java.lang.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.java.lang.StringtoString()Returns a JSON string representation of ParameterModel
-
-
-
Method Detail
-
getId
public java.lang.Long getId()
Getter for id The unique ID number of this property.
-
setId
public void setId(java.lang.Long value)
Setter for id The unique ID number of this property.
-
getCategory
public java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.String getDataType()
Getter for dataType The data type of the property.
-
setDataType
public void setDataType(java.lang.String value)
Setter for dataType The data type of the property.
-
getHelpText
public java.lang.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(java.lang.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 java.util.ArrayList<java.lang.String> getServiceTypes()
Getter for serviceTypes A list of service types to which this parameter applies.
-
setServiceTypes
public void setServiceTypes(java.util.ArrayList<java.lang.String> value)
Setter for serviceTypes A list of service types to which this parameter applies.
-
getPrompt
public java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.String getLabel()
Getter for label Label that helps the user to identify a parameter
-
setLabel
public void setLabel(java.lang.String value)
Setter for label Label that helps the user to identify a parameter
-
getHelpUrl
public java.lang.String getHelpUrl()
Getter for helpUrl A help url that provides more information about the parameter
-
setHelpUrl
public void setHelpUrl(java.lang.String value)
Setter for helpUrl A help url that provides more information about the parameter
-
getAttributeType
public java.lang.String getAttributeType()
Getter for attributeType The type of parameter as determined by its application, e.g. Product, Transaction, Calculated
-
setAttributeType
public void setAttributeType(java.lang.String value)
Setter for attributeType The type of parameter as determined by its application, e.g. Product, Transaction, Calculated
-
getValues
public java.util.ArrayList<java.lang.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(java.util.ArrayList<java.lang.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 java.lang.String getMeasurementType()
Getter for measurementType The unit of measurement type of the parameter
-
setMeasurementType
public void setMeasurementType(java.lang.String value)
Setter for measurementType The unit of measurement type of the parameter
-
toString
public java.lang.String toString()
Returns a JSON string representation of ParameterModel- Overrides:
toStringin classjava.lang.Object
-
-