net.avalara.avatax.rest.client.models

Class ParameterModel

java.lang.Object

net.avalara.avatax.rest.client.models.ParameterModel

public class ParameterModel
extends java.lang.Object

An extra property that can change the behavior of tax transactions.

Constructor Summary

Constructors

Constructor and Description
ParameterModel()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCategory() Getter for category The category grouping of this parameter.
ParameterBagDataType	getDataType() Getter for dataType The data type of the property.
java.lang.String	getHelpText() Getter for helpText Help text to be shown to the user when they are filling out this parameter.
java.lang.Long	getId() Getter for id The unique ID number of this property.
java.lang.String	getName() Getter for name The name of the property.
java.lang.String	getPrompt() Getter for prompt The prompt you should use when displaying this parameter to a user.
java.lang.String	getRegularExpression() Getter for regularExpression 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.
java.util.ArrayList<java.lang.String>	getServiceTypes() Getter for serviceTypes A list of service types to which this parameter applies.
void	setCategory(java.lang.String value) Setter for category The category grouping of this parameter.
void	setDataType(ParameterBagDataType value) Setter for dataType The data type of the property.
void	setHelpText(java.lang.String value) Setter for helpText Help text to be shown to the user when they are filling out this parameter.
void	setId(java.lang.Long value) Setter for id The unique ID number of this property.
void	setName(java.lang.String value) Setter for name The name of the property.
void	setPrompt(java.lang.String value) Setter for prompt The prompt you should use when displaying this parameter to a user.
void	setRegularExpression(java.lang.String value) Setter for regularExpression 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.
void	setServiceTypes(java.util.ArrayList<java.lang.String> value) Setter for serviceTypes A list of service types to which this parameter applies.
java.lang.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 Detail

ParameterModel

public 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 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 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 `/api/v2/transactions/create` 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 `/api/v2/transactions/create` call.

getDataType

public ParameterBagDataType getDataType()

Getter for dataType The data type of the property.

setDataType

public void setDataType(ParameterBagDataType 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 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 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 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 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.

toString

public java.lang.String toString()

Returns a JSON string representation of ParameterModel

Overrides:

toString in class java.lang.Object