Package com.mypurecloud.sdk.v2.model

Class KnowledgeDocumentQuery

java.lang.Object

com.mypurecloud.sdk.v2.model.KnowledgeDocumentQuery

All Implemented Interfaces:

Serializable

public class KnowledgeDocumentQuery
extends Object
implements Serializable

KnowledgeDocumentQuery

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	KnowledgeDocumentQuery.IncludeVariationsEnum	Indicates which document variations to include in returned documents.
static enum	KnowledgeDocumentQuery.SortByEnum	The field in the documents that you want to sort the results by.
static enum	KnowledgeDocumentQuery.SortOrderEnum	The sort order for results.

Constructor Summary

Constructors

Constructor	Description
KnowledgeDocumentQuery()
KnowledgeDocumentQuery(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
KnowledgeDocumentQuery	filter(DocumentQuery filter)	Filter for the document query.
DocumentQuery	getFilter()
Boolean	getIncludeDraftDocuments()
KnowledgeDocumentQuery.IncludeVariationsEnum	getIncludeVariations()
DocumentQueryInterval	getInterval()
Integer	getPageNumber()
Integer	getPageSize()
KnowledgeDocumentQuery.SortByEnum	getSortBy()
KnowledgeDocumentQuery.SortOrderEnum	getSortOrder()
int	hashCode()
KnowledgeDocumentQuery	includeDraftDocuments(Boolean includeDraftDocuments)	Indicates whether the results would also include draft documents.
KnowledgeDocumentQuery	includeVariations(KnowledgeDocumentQuery.IncludeVariationsEnum includeVariations)	Indicates which document variations to include in returned documents.
KnowledgeDocumentQuery	interval(DocumentQueryInterval interval)	Retrieves the documents created/modified/published in specified date and time range.
KnowledgeDocumentQuery	pageNumber(Integer pageNumber)	Page number of the returned results.
KnowledgeDocumentQuery	pageSize(Integer pageSize)	Page size of the returned results.
void	setFilter(DocumentQuery filter)
void	setIncludeDraftDocuments(Boolean includeDraftDocuments)
void	setIncludeVariations(KnowledgeDocumentQuery.IncludeVariationsEnum includeVariations)
void	setInterval(DocumentQueryInterval interval)
void	setPageNumber(Integer pageNumber)
void	setPageSize(Integer pageSize)
void	setSortBy(KnowledgeDocumentQuery.SortByEnum sortBy)
void	setSortOrder(KnowledgeDocumentQuery.SortOrderEnum sortOrder)
KnowledgeDocumentQuery	sortBy(KnowledgeDocumentQuery.SortByEnum sortBy)	The field in the documents that you want to sort the results by.
KnowledgeDocumentQuery	sortOrder(KnowledgeDocumentQuery.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

KnowledgeDocumentQuery

public KnowledgeDocumentQuery()

KnowledgeDocumentQuery

public KnowledgeDocumentQuery(Boolean initWithEmptyList)

Method Details

pageSize

public KnowledgeDocumentQuery pageSize(Integer pageSize)

Page size of the returned results.

getPageSize

public Integer getPageSize()

setPageSize

public void setPageSize(Integer pageSize)

pageNumber

public KnowledgeDocumentQuery pageNumber(Integer pageNumber)

Page number of the returned results.

getPageNumber

public Integer getPageNumber()

setPageNumber

public void setPageNumber(Integer pageNumber)

includeDraftDocuments

public KnowledgeDocumentQuery includeDraftDocuments(Boolean includeDraftDocuments)

Indicates whether the results would also include draft documents.

getIncludeDraftDocuments

public Boolean getIncludeDraftDocuments()

setIncludeDraftDocuments

public void setIncludeDraftDocuments(Boolean includeDraftDocuments)

interval

public KnowledgeDocumentQuery interval(DocumentQueryInterval interval)

Retrieves the documents created/modified/published in specified date and time range.

getInterval

public DocumentQueryInterval getInterval()

setInterval

public void setInterval(DocumentQueryInterval interval)

filter

public KnowledgeDocumentQuery filter(DocumentQuery filter)

Filter for the document query.

getFilter

public DocumentQuery getFilter()

setFilter

public void setFilter(DocumentQuery filter)

includeVariations

public KnowledgeDocumentQuery includeVariations(KnowledgeDocumentQuery.IncludeVariationsEnum includeVariations)

Indicates which document variations to include in returned documents. All: all variations regardless of the filter expression; AllMatching: all variations that match the filter expression; SingleMostRelevant: single variation that matches the filter expression and has the highest priority. The default is All.

getIncludeVariations

public KnowledgeDocumentQuery.IncludeVariationsEnum getIncludeVariations()

setIncludeVariations

public void setIncludeVariations(KnowledgeDocumentQuery.IncludeVariationsEnum includeVariations)

sortOrder

public KnowledgeDocumentQuery sortOrder(KnowledgeDocumentQuery.SortOrderEnum sortOrder)

The sort order for results.

getSortOrder

public KnowledgeDocumentQuery.SortOrderEnum getSortOrder()

setSortOrder

public void setSortOrder(KnowledgeDocumentQuery.SortOrderEnum sortOrder)

sortBy

public KnowledgeDocumentQuery sortBy(KnowledgeDocumentQuery.SortByEnum sortBy)

The field in the documents that you want to sort the results by.

getSortBy

public KnowledgeDocumentQuery.SortByEnum getSortBy()

setSortBy

public void setSortBy(KnowledgeDocumentQuery.SortByEnum sortBy)

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