Package dev.array21.espocrm.types

Class Where

java.lang.Object

dev.array21.espocrm.types.Where

public class Where
extends java.lang.Object

Where parameter is an array if items, that can contain nested items. The data should be URL-encoded. API clients provided in the documentation handle encoding.
Refer to the EspoCRM documentation for more information

Since:

1.0.0

Constructor Summary

Constructors

Constructor	Description
Where(FilterType filterType, java.lang.String attribute)	Create a new Where filter

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAttribute()	The attribute to apply the filter to
FilterType	getFilterType()	The FilterType to use
java.lang.Object	getValue()	The value Field.
Where	setAttribute(java.lang.String attribute)	The attribute to apply the filter to.
Where	setFilterType(FilterType filterType)	The FilterType to use.
Where	setValueString(java.lang.String value)	Set the Value field to a String
Where	setValueStringArray(java.lang.String[] value)	Set the Value field to a String[]
Where	setValueStringList(java.util.List<java.lang.String> value)	Set the Value field to a List, this is converted to a String[]

Methods inherited from class java.lang.Object

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

Constructor Detail

Where

public Where(FilterType filterType,
             java.lang.String attribute)

Create a new Where filter

Parameters:

filterType - The FilterType. See: setFilterType(FilterType)

attribute - The attribute. See setAttribute(String)

Method Detail

setFilterType

public Where setFilterType(FilterType filterType)

The FilterType to use. This may not be left null.

Parameters:

filterType - The filterType

Returns:

Returns an instance of Where for easy chaining

See Also:

FilterType

getFilterType

public FilterType getFilterType()

The FilterType to use

Returns:

Returns the FilterType

setAttribute

public Where setAttribute(java.lang.String attribute)

The attribute to apply the filter to. This may not be left null.s

Parameters:

attribute - The attribute

Returns:

Returns an instance of Where for easy chaining

getAttribute

public java.lang.String getAttribute()

The attribute to apply the filter to

Returns:

Returns the attribute

setValueString

public Where setValueString(java.lang.String value)

Set the Value field to a String

Parameters:

value - The value

Returns:

Returns an instance of Where for easy chaining

setValueStringArray

public Where setValueStringArray(java.lang.String[] value)

Set the Value field to a String[]

Parameters:

value - The value

Returns:

Returns an instance of Where for easy chaining

setValueStringList

public Where setValueStringList(java.util.List<java.lang.String> value)

Set the Value field to a List, this is converted to a String[]

Parameters:

value - The value

Returns:

Returns an instance of Where for easy chaining

getValue

public java.lang.Object getValue()

The value Field. Can be a String or a String[]

Returns:

The value