com.squareup.square.models

Class CustomAttributeFilter

java.lang.Object

com.squareup.square.models.CustomAttributeFilter

public class CustomAttributeFilter
extends Object

This is a model class for CustomAttributeFilter type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomAttributeFilter.Builder Class to build instances of CustomAttributeFilter.

Constructor Summary

Constructors

Constructor and Description
CustomAttributeFilter(String customAttributeDefinitionId, String key, String stringFilter, Range numberFilter, List<String> selectionUidsFilter, Boolean boolFilter) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Boolean	getBoolFilter() Getter for BoolFilter.
String	getCustomAttributeDefinitionId() Getter for CustomAttributeDefinitionId.
String	getKey() Getter for Key.
Range	getNumberFilter() Getter for NumberFilter.
List<String>	getSelectionUidsFilter() Getter for SelectionUidsFilter.
String	getStringFilter() Getter for StringFilter.
int	hashCode()
CustomAttributeFilter.Builder	toBuilder() Builds a new CustomAttributeFilter.Builder object.
String	toString() Converts this CustomAttributeFilter into string format.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CustomAttributeFilter

public CustomAttributeFilter(String customAttributeDefinitionId,
                             String key,
                             String stringFilter,
                             Range numberFilter,
                             List<String> selectionUidsFilter,
                             Boolean boolFilter)

Initialization constructor.

Parameters:

customAttributeDefinitionId - String value for customAttributeDefinitionId.

key - String value for key.

stringFilter - String value for stringFilter.

numberFilter - Range value for numberFilter.

selectionUidsFilter - List of String value for selectionUidsFilter.

boolFilter - Boolean value for boolFilter.

Method Detail

getCustomAttributeDefinitionId

public String getCustomAttributeDefinitionId()

Getter for CustomAttributeDefinitionId. A query expression to filter items or item variations by matching their custom attributes' `custom_attribute_definition_id` property value against the the specified id. Exactly one of `custom_attribute_definition_id` or `key` must be specified.

Returns:

Returns the String

getKey

public String getKey()

Getter for Key. A query expression to filter items or item variations by matching their custom attributes' `key` property value against the specified key. Exactly one of `custom_attribute_definition_id` or `key` must be specified.

Returns:

Returns the String

getStringFilter

public String getStringFilter()

Getter for StringFilter. A query expression to filter items or item variations by matching their custom attributes' `string_value` property value against the specified text. Exactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified.

Returns:

Returns the String

getNumberFilter

public Range getNumberFilter()

Getter for NumberFilter. The range of a number value between the specified lower and upper bounds.

Returns:

Returns the Range

getSelectionUidsFilter

public List<String> getSelectionUidsFilter()

Getter for SelectionUidsFilter. A query expression to filter items or item variations by matching their custom attributes' `selection_uid_values` values against the specified selection uids. Exactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified.

Returns:

Returns the List of String

getBoolFilter

public Boolean getBoolFilter()

Getter for BoolFilter. A query expression to filter items or item variations by matching their custom attributes' `boolean_value` property values against the specified Boolean expression. Exactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified.

Returns:

Returns the Boolean

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Converts this CustomAttributeFilter into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CustomAttributeFilter.Builder toBuilder()

Builds a new CustomAttributeFilter.Builder object. Creates the instance with the state of the current model.

Returns:

a new CustomAttributeFilter.Builder object