Package com.mypurecloud.sdk.v2.model

Class DocumentationSearchResponse

java.lang.Object

com.mypurecloud.sdk.v2.model.DocumentationSearchResponse

All Implemented Interfaces:

Serializable

public class DocumentationSearchResponse
extends Object
implements Serializable

DocumentationSearchResponse

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
DocumentationSearchResponse()
DocumentationSearchResponse(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
DocumentationSearchResponse	currentPage(String currentPage)	Q64 value for the current page of results
boolean	equals(Object o)
String	getCurrentPage()
String	getNextPage()
Integer	getPageCount()
Integer	getPageNumber()
Integer	getPageSize()
String	getPreviousPage()
List<DocumentationResult>	getResults()
Long	getTotal()
List<String>	getTypes()
int	hashCode()
DocumentationSearchResponse	nextPage(String nextPage)	Q64 value for the next page of results
DocumentationSearchResponse	pageCount(Integer pageCount)	The total number of pages
DocumentationSearchResponse	pageNumber(Integer pageNumber)	The current page number
DocumentationSearchResponse	pageSize(Integer pageSize)	The current page size
DocumentationSearchResponse	previousPage(String previousPage)	Q64 value for the previous page of results
DocumentationSearchResponse	results(List<DocumentationResult> results)	Search results
void	setCurrentPage(String currentPage)
void	setNextPage(String nextPage)
void	setPageCount(Integer pageCount)
void	setPageNumber(Integer pageNumber)
void	setPageSize(Integer pageSize)
void	setPreviousPage(String previousPage)
void	setResults(List<DocumentationResult> results)
void	setTotal(Long total)
void	setTypes(List<String> types)
String	toString()
DocumentationSearchResponse	total(Long total)	The total number of results found
DocumentationSearchResponse	types(List<String> types)	Resource types the search was performed against

Methods inherited from class java.lang.Object

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

Constructor Details

DocumentationSearchResponse

public DocumentationSearchResponse()

DocumentationSearchResponse

public DocumentationSearchResponse(Boolean initWithEmptyList)

Method Details

total

public DocumentationSearchResponse total(Long total)

The total number of results found

getTotal

public Long getTotal()

setTotal

public void setTotal(Long total)

pageCount

public DocumentationSearchResponse pageCount(Integer pageCount)

The total number of pages

getPageCount

public Integer getPageCount()

setPageCount

public void setPageCount(Integer pageCount)

pageSize

public DocumentationSearchResponse pageSize(Integer pageSize)

The current page size

getPageSize

public Integer getPageSize()

setPageSize

public void setPageSize(Integer pageSize)

pageNumber

public DocumentationSearchResponse pageNumber(Integer pageNumber)

The current page number

getPageNumber

public Integer getPageNumber()

setPageNumber

public void setPageNumber(Integer pageNumber)

previousPage

public DocumentationSearchResponse previousPage(String previousPage)

Q64 value for the previous page of results

getPreviousPage

public String getPreviousPage()

setPreviousPage

public void setPreviousPage(String previousPage)

currentPage

public DocumentationSearchResponse currentPage(String currentPage)

Q64 value for the current page of results

getCurrentPage

public String getCurrentPage()

setCurrentPage

public void setCurrentPage(String currentPage)

nextPage

public DocumentationSearchResponse nextPage(String nextPage)

Q64 value for the next page of results

getNextPage

public String getNextPage()

setNextPage

public void setNextPage(String nextPage)

types

public DocumentationSearchResponse types(List<String> types)

Resource types the search was performed against

getTypes

public List<String> getTypes()

setTypes

public void setTypes(List<String> types)

results

public DocumentationSearchResponse results(List<DocumentationResult> results)

Search results

getResults

public List<DocumentationResult> getResults()

setResults

public void setResults(List<DocumentationResult> results)

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