Package com.mypurecloud.sdk.v2.model

Class WorkbinQueryRequest

java.lang.Object

com.mypurecloud.sdk.v2.model.WorkbinQueryRequest

All Implemented Interfaces:

Serializable

public class WorkbinQueryRequest
extends Object
implements Serializable

WorkbinQueryRequest

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WorkbinQueryRequest.SelectEnum	Specify the value 'Count' for this parameter in order to return only the record count.

Constructor Summary

Constructors

Constructor	Description
WorkbinQueryRequest()
WorkbinQueryRequest(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
WorkbinQueryRequest	after(String after)	The cursor that points to the end of the set of entities that has been returned.
WorkbinQueryRequest	attributes(List<String> attributes)	List of entity attributes to be retrieved in the result.
boolean	equals(Object o)
WorkbinQueryRequest	filters(List<WorkitemFilter> filters)	List of filter objects to be used in the search.
String	getAfter()
List<String>	getAttributes()
List<WorkitemFilter>	getFilters()
Integer	getPageSize()
WorkbinQueryRequest.SelectEnum	getSelect()
WorkbinQuerySort	getSort()
int	hashCode()
WorkbinQueryRequest	pageSize(Integer pageSize)	Limit the number of entities to return.
WorkbinQueryRequest	select(WorkbinQueryRequest.SelectEnum select)	Specify the value 'Count' for this parameter in order to return only the record count.
void	setAfter(String after)
void	setAttributes(List<String> attributes)
void	setFilters(List<WorkitemFilter> filters)
void	setPageSize(Integer pageSize)
void	setSelect(WorkbinQueryRequest.SelectEnum select)
void	setSort(WorkbinQuerySort sort)
WorkbinQueryRequest	sort(WorkbinQuerySort sort)	Sort
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

WorkbinQueryRequest

public WorkbinQueryRequest()

WorkbinQueryRequest

public WorkbinQueryRequest(Boolean initWithEmptyList)

Method Details

pageSize

public WorkbinQueryRequest pageSize(Integer pageSize)

Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200.

getPageSize

public Integer getPageSize()

setPageSize

public void setPageSize(Integer pageSize)

select

public WorkbinQueryRequest select(WorkbinQueryRequest.SelectEnum select)

Specify the value 'Count' for this parameter in order to return only the record count.

getSelect

public WorkbinQueryRequest.SelectEnum getSelect()

setSelect

public void setSelect(WorkbinQueryRequest.SelectEnum select)

filters

public WorkbinQueryRequest filters(List<WorkitemFilter> filters)

List of filter objects to be used in the search. Valid filter names are: 'id', 'name', 'description', 'divisionId', 'dateCreated', 'dateModified', 'modifiedBy'

getFilters

public List<WorkitemFilter> getFilters()

setFilters

public void setFilters(List<WorkitemFilter> filters)

attributes

public WorkbinQueryRequest attributes(List<String> attributes)

List of entity attributes to be retrieved in the result.

getAttributes

public List<String> getAttributes()

setAttributes

public void setAttributes(List<String> attributes)

after

public WorkbinQueryRequest after(String after)

The cursor that points to the end of the set of entities that has been returned.

getAfter

public String getAfter()

setAfter

public void setAfter(String after)

sort

public WorkbinQueryRequest sort(WorkbinQuerySort sort)

Sort

getSort

public WorkbinQuerySort getSort()

setSort

public void setSort(WorkbinQuerySort sort)

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