Package com.mypurecloud.sdk.v2.model

Class KnowledgeDocumentQueryResult

java.lang.Object

com.mypurecloud.sdk.v2.model.KnowledgeDocumentQueryResult

All Implemented Interfaces:

Serializable

public class KnowledgeDocumentQueryResult
extends Object
implements Serializable

KnowledgeDocumentQueryResult

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	KnowledgeDocumentQueryResult.StateEnum	State of the document.

Constructor Summary

Constructors

Constructor	Description
KnowledgeDocumentQueryResult()
KnowledgeDocumentQueryResult(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
KnowledgeDocumentQueryResult	alternatives(List<KnowledgeDocumentAlternative> alternatives)	List of alternate phrases related to the title which improves search results.
KnowledgeDocumentQueryResult	category(CategoryResponse category)	The reference to category associated with the document.
KnowledgeDocumentQueryResult	dateCreated(Date dateCreated)	Document creation date-time.
KnowledgeDocumentQueryResult	dateImported(Date dateImported)	Document import date-time, or null if was not imported.
KnowledgeDocumentQueryResult	dateModified(Date dateModified)	Document last modification date-time.
KnowledgeDocumentQueryResult	datePublished(Date datePublished)	The date on which the document was last published.
KnowledgeDocumentQueryResult	documentVersion(AddressableEntityRef documentVersion)	The version of the document.
boolean	equals(Object o)
KnowledgeDocumentQueryResult	externalId(String externalId)	The reference to external id associated with the document.
KnowledgeDocumentQueryResult	externalUrl(String externalUrl)	The URL to external document.
List<KnowledgeDocumentAlternative>	getAlternatives()
CategoryResponse	getCategory()
UserReference	getCreatedBy()
Date	getDateCreated()
Date	getDateImported()
Date	getDateModified()
Date	getDatePublished()
AddressableEntityRef	getDocumentVersion()
String	getExternalId()
String	getExternalUrl()
String	getId()
KnowledgeBaseReference	getKnowledgeBase()
List<LabelResponse>	getLabels()
Integer	getLastPublishedVersionNumber()
UserReference	getModifiedBy()
Boolean	getReadonly()
String	getSelfUri()
AddressableEntityRef	getSource()
KnowledgeDocumentQueryResult.StateEnum	getState()
String	getTitle()
List<KnowledgeDocumentQueryVariation>	getVariations()
Boolean	getVisible()
int	hashCode()
KnowledgeDocumentQueryResult	knowledgeBase(KnowledgeBaseReference knowledgeBase)	Knowledge base to which the document belongs to.
KnowledgeDocumentQueryResult	labels(List<LabelResponse> labels)	The references to labels associated with the document.
KnowledgeDocumentQueryResult	lastPublishedVersionNumber(Integer lastPublishedVersionNumber)	The last published version number of the document.
KnowledgeDocumentQueryResult	readonly(Boolean readonly)	Whether the document is read-only.
void	setAlternatives(List<KnowledgeDocumentAlternative> alternatives)
void	setCategory(CategoryResponse category)
void	setDateCreated(Date dateCreated)
void	setDateImported(Date dateImported)
void	setDateModified(Date dateModified)
void	setDatePublished(Date datePublished)
void	setDocumentVersion(AddressableEntityRef documentVersion)
void	setExternalId(String externalId)
void	setExternalUrl(String externalUrl)
void	setKnowledgeBase(KnowledgeBaseReference knowledgeBase)
void	setLabels(List<LabelResponse> labels)
void	setLastPublishedVersionNumber(Integer lastPublishedVersionNumber)
void	setReadonly(Boolean readonly)
void	setSource(AddressableEntityRef source)
void	setState(KnowledgeDocumentQueryResult.StateEnum state)
void	setTitle(String title)
void	setVariations(List<KnowledgeDocumentQueryVariation> variations)
void	setVisible(Boolean visible)
KnowledgeDocumentQueryResult	source(AddressableEntityRef source)	The reference to source associated with the document.
KnowledgeDocumentQueryResult	state(KnowledgeDocumentQueryResult.StateEnum state)	State of the document.
KnowledgeDocumentQueryResult	title(String title)	Document title, having a limit of 500 words.
String	toString()
KnowledgeDocumentQueryResult	variations(List<KnowledgeDocumentQueryVariation> variations)	Variations of the document.
KnowledgeDocumentQueryResult	visible(Boolean visible)	Indicates if the knowledge document should be included in search results.

Methods inherited from class java.lang.Object

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

Constructor Details

KnowledgeDocumentQueryResult

public KnowledgeDocumentQueryResult()

KnowledgeDocumentQueryResult

public KnowledgeDocumentQueryResult(Boolean initWithEmptyList)

Method Details

getId

public String getId()

title

public KnowledgeDocumentQueryResult title(String title)

Document title, having a limit of 500 words.

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

visible

public KnowledgeDocumentQueryResult visible(Boolean visible)

Indicates if the knowledge document should be included in search results.

getVisible

public Boolean getVisible()

setVisible

public void setVisible(Boolean visible)

alternatives

public KnowledgeDocumentQueryResult alternatives(List<KnowledgeDocumentAlternative> alternatives)

List of alternate phrases related to the title which improves search results.

getAlternatives

public List<KnowledgeDocumentAlternative> getAlternatives()

setAlternatives

public void setAlternatives(List<KnowledgeDocumentAlternative> alternatives)

state

public KnowledgeDocumentQueryResult state(KnowledgeDocumentQueryResult.StateEnum state)

State of the document.

getState

public KnowledgeDocumentQueryResult.StateEnum getState()

setState

public void setState(KnowledgeDocumentQueryResult.StateEnum state)

dateCreated

public KnowledgeDocumentQueryResult dateCreated(Date dateCreated)

Document creation date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getDateCreated

public Date getDateCreated()

setDateCreated

public void setDateCreated(Date dateCreated)

dateModified

public KnowledgeDocumentQueryResult dateModified(Date dateModified)

Document last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getDateModified

public Date getDateModified()

setDateModified

public void setDateModified(Date dateModified)

dateImported

public KnowledgeDocumentQueryResult dateImported(Date dateImported)

Document import date-time, or null if was not imported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getDateImported

public Date getDateImported()

setDateImported

public void setDateImported(Date dateImported)

lastPublishedVersionNumber

public KnowledgeDocumentQueryResult lastPublishedVersionNumber(Integer lastPublishedVersionNumber)

The last published version number of the document.

getLastPublishedVersionNumber

public Integer getLastPublishedVersionNumber()

setLastPublishedVersionNumber

public void setLastPublishedVersionNumber(Integer lastPublishedVersionNumber)

datePublished

public KnowledgeDocumentQueryResult datePublished(Date datePublished)

The date on which the document was last published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getDatePublished

public Date getDatePublished()

setDatePublished

public void setDatePublished(Date datePublished)

getCreatedBy

public UserReference getCreatedBy()

getModifiedBy

public UserReference getModifiedBy()

documentVersion

public KnowledgeDocumentQueryResult documentVersion(AddressableEntityRef documentVersion)

The version of the document.

getDocumentVersion

public AddressableEntityRef getDocumentVersion()

setDocumentVersion

public void setDocumentVersion(AddressableEntityRef documentVersion)

category

public KnowledgeDocumentQueryResult category(CategoryResponse category)

The reference to category associated with the document.

getCategory

public CategoryResponse getCategory()

setCategory

public void setCategory(CategoryResponse category)

labels

public KnowledgeDocumentQueryResult labels(List<LabelResponse> labels)

The references to labels associated with the document.

getLabels

public List<LabelResponse> getLabels()

setLabels

public void setLabels(List<LabelResponse> labels)

knowledgeBase

public KnowledgeDocumentQueryResult knowledgeBase(KnowledgeBaseReference knowledgeBase)

Knowledge base to which the document belongs to.

getKnowledgeBase

public KnowledgeBaseReference getKnowledgeBase()

setKnowledgeBase

public void setKnowledgeBase(KnowledgeBaseReference knowledgeBase)

externalId

public KnowledgeDocumentQueryResult externalId(String externalId)

The reference to external id associated with the document.

getExternalId

public String getExternalId()

setExternalId

public void setExternalId(String externalId)

externalUrl

public KnowledgeDocumentQueryResult externalUrl(String externalUrl)

The URL to external document.

getExternalUrl

public String getExternalUrl()

setExternalUrl

public void setExternalUrl(String externalUrl)

source

public KnowledgeDocumentQueryResult source(AddressableEntityRef source)

The reference to source associated with the document.

getSource

public AddressableEntityRef getSource()

setSource

public void setSource(AddressableEntityRef source)

readonly

public KnowledgeDocumentQueryResult readonly(Boolean readonly)

Whether the document is read-only.

getReadonly

public Boolean getReadonly()

setReadonly

public void setReadonly(Boolean readonly)

variations

public KnowledgeDocumentQueryResult variations(List<KnowledgeDocumentQueryVariation> variations)

Variations of the document.

getVariations

public List<KnowledgeDocumentQueryVariation> getVariations()

setVariations

public void setVariations(List<KnowledgeDocumentQueryVariation> variations)

getSelfUri

public String getSelfUri()

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