Package com.mypurecloud.sdk.v2.model

Class DocumentationSearchCriteria

java.lang.Object

com.mypurecloud.sdk.v2.model.DocumentationSearchCriteria

All Implemented Interfaces:

Serializable

public class DocumentationSearchCriteria
extends Object
implements Serializable

DocumentationSearchCriteria

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DocumentationSearchCriteria.OperatorEnum	How to apply this search criteria against other criteria
static enum	DocumentationSearchCriteria.TypeEnum	Search Type

Constructor Summary

Constructors

Constructor	Description
DocumentationSearchCriteria()
DocumentationSearchCriteria(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
DocumentationSearchCriteria	dateFormat(String dateFormat)	Set date format for criteria values when using date range search type.
DocumentationSearchCriteria	endValue(String endValue)	The end value of the range.
boolean	equals(Object o)
DocumentationSearchCriteria	fields(List<String> fields)	Field names to search against
String	getDateFormat()
String	getEndValue()
List<String>	getFields()
List<DocumentationSearchCriteria>	getGroup()
DocumentationSearchCriteria.OperatorEnum	getOperator()
String	getStartValue()
DocumentationSearchCriteria.TypeEnum	getType()
String	getValue()
List<String>	getValues()
DocumentationSearchCriteria	group(List<DocumentationSearchCriteria> group)	Groups multiple conditions
int	hashCode()
DocumentationSearchCriteria	operator(DocumentationSearchCriteria.OperatorEnum operator)	How to apply this search criteria against other criteria
void	setDateFormat(String dateFormat)
void	setEndValue(String endValue)
void	setFields(List<String> fields)
void	setGroup(List<DocumentationSearchCriteria> group)
void	setOperator(DocumentationSearchCriteria.OperatorEnum operator)
void	setStartValue(String startValue)
void	setType(DocumentationSearchCriteria.TypeEnum type)
void	setValue(String value)
void	setValues(List<String> values)
DocumentationSearchCriteria	startValue(String startValue)	The start value of the range.
String	toString()
DocumentationSearchCriteria	type(DocumentationSearchCriteria.TypeEnum type)	Search Type
DocumentationSearchCriteria	value(String value)	A value for the search to match against
DocumentationSearchCriteria	values(List<String> values)	A list of values for the search to match against

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentationSearchCriteria

public DocumentationSearchCriteria()

DocumentationSearchCriteria

public DocumentationSearchCriteria(Boolean initWithEmptyList)

Method Details

endValue

public DocumentationSearchCriteria endValue(String endValue)

The end value of the range. This field is used for range search types.

getEndValue

public String getEndValue()

setEndValue

public void setEndValue(String endValue)

values

public DocumentationSearchCriteria values(List<String> values)

A list of values for the search to match against

getValues

public List<String> getValues()

setValues

public void setValues(List<String> values)

startValue

public DocumentationSearchCriteria startValue(String startValue)

The start value of the range. This field is used for range search types.

getStartValue

public String getStartValue()

setStartValue

public void setStartValue(String startValue)

value

public DocumentationSearchCriteria value(String value)

A value for the search to match against

getValue

public String getValue()

setValue

public void setValue(String value)

operator

public DocumentationSearchCriteria operator(DocumentationSearchCriteria.OperatorEnum operator)

How to apply this search criteria against other criteria

getOperator

public DocumentationSearchCriteria.OperatorEnum getOperator()

setOperator

public void setOperator(DocumentationSearchCriteria.OperatorEnum operator)

group

public DocumentationSearchCriteria group(List<DocumentationSearchCriteria> group)

Groups multiple conditions

getGroup

public List<DocumentationSearchCriteria> getGroup()

setGroup

public void setGroup(List<DocumentationSearchCriteria> group)

dateFormat

public DocumentationSearchCriteria dateFormat(String dateFormat)

Set date format for criteria values when using date range search type. Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX.

getDateFormat

public String getDateFormat()

setDateFormat

public void setDateFormat(String dateFormat)

type

public DocumentationSearchCriteria type(DocumentationSearchCriteria.TypeEnum type)

Search Type

getType

public DocumentationSearchCriteria.TypeEnum getType()

setType

public void setType(DocumentationSearchCriteria.TypeEnum type)

fields

public DocumentationSearchCriteria fields(List<String> fields)

Field names to search against

getFields

public List<String> getFields()

setFields

public void setFields(List<String> fields)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object