Package com.mypurecloud.sdk.v2.model

Class DocumentationSearchRequest

java.lang.Object

com.mypurecloud.sdk.v2.model.DocumentationSearchRequest

All Implemented Interfaces:

Serializable

public class DocumentationSearchRequest
extends Object
implements Serializable

DocumentationSearchRequest

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DocumentationSearchRequest.SortOrderEnum	The sort order for results

Constructor Summary

Constructors

Constructor	Description
DocumentationSearchRequest()
DocumentationSearchRequest(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Integer	getPageNumber()
Integer	getPageSize()
List<DocumentationSearchCriteria>	getQuery()
List<SearchSort>	getSort()
String	getSortBy()
DocumentationSearchRequest.SortOrderEnum	getSortOrder()
int	hashCode()
DocumentationSearchRequest	pageNumber(Integer pageNumber)	The page of resources you want to retrieve
DocumentationSearchRequest	pageSize(Integer pageSize)	The number of results per page
DocumentationSearchRequest	query(List<DocumentationSearchCriteria> query)
void	setPageNumber(Integer pageNumber)
void	setPageSize(Integer pageSize)
void	setQuery(List<DocumentationSearchCriteria> query)
void	setSort(List<SearchSort> sort)
void	setSortBy(String sortBy)
void	setSortOrder(DocumentationSearchRequest.SortOrderEnum sortOrder)
DocumentationSearchRequest	sort(List<SearchSort> sort)	Multi-value sort order, list of multiple sort values
DocumentationSearchRequest	sortBy(String sortBy)	The field in the resource that you want to sort the results by
DocumentationSearchRequest	sortOrder(DocumentationSearchRequest.SortOrderEnum sortOrder)	The sort order for results
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentationSearchRequest

public DocumentationSearchRequest()

DocumentationSearchRequest

public DocumentationSearchRequest(Boolean initWithEmptyList)

Method Details

sortOrder

public DocumentationSearchRequest sortOrder(DocumentationSearchRequest.SortOrderEnum sortOrder)

The sort order for results

getSortOrder

public DocumentationSearchRequest.SortOrderEnum getSortOrder()

setSortOrder

public void setSortOrder(DocumentationSearchRequest.SortOrderEnum sortOrder)

sortBy

public DocumentationSearchRequest sortBy(String sortBy)

The field in the resource that you want to sort the results by

getSortBy

public String getSortBy()

setSortBy

public void setSortBy(String sortBy)

pageSize

public DocumentationSearchRequest pageSize(Integer pageSize)

The number of results per page

getPageSize

public Integer getPageSize()

setPageSize

public void setPageSize(Integer pageSize)

pageNumber

public DocumentationSearchRequest pageNumber(Integer pageNumber)

The page of resources you want to retrieve

getPageNumber

public Integer getPageNumber()

setPageNumber

public void setPageNumber(Integer pageNumber)

sort

public DocumentationSearchRequest sort(List<SearchSort> sort)

Multi-value sort order, list of multiple sort values

getSort

public List<SearchSort> getSort()

setSort

public void setSort(List<SearchSort> sort)

query

public DocumentationSearchRequest query(List<DocumentationSearchCriteria> query)

getQuery

public List<DocumentationSearchCriteria> getQuery()

setQuery

public void setQuery(List<DocumentationSearchCriteria> query)

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