Package com.mypurecloud.sdk.v2.model

Class KnowledgeSearchDocumentResponse

java.lang.Object

com.mypurecloud.sdk.v2.model.KnowledgeSearchDocumentResponse

All Implemented Interfaces:

Serializable

public class KnowledgeSearchDocumentResponse
extends Object
implements Serializable

KnowledgeSearchDocumentResponse

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
KnowledgeSearchDocumentResponse()
KnowledgeSearchDocumentResponse(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
KnowledgeSearchDocumentResponse	alternatives(List<KnowledgeDocumentAlternative> alternatives)	List of alternate phrases related to the title which improves search results.
KnowledgeSearchDocumentResponse	answer(String answer)	The answer to the query.
KnowledgeSearchDocumentResponse	category(CategoryResponse category)	The reference to category associated with the document.
KnowledgeSearchDocumentResponse	dateCreated(Date dateCreated)	Document creation date-time.
KnowledgeSearchDocumentResponse	dateImported(Date dateImported)	Document import date-time, or null if was not imported.
KnowledgeSearchDocumentResponse	dateModified(Date dateModified)	Document last modification date-time.
KnowledgeSearchDocumentResponse	datePublished(Date datePublished)	The date on which the document was last published.
KnowledgeSearchDocumentResponse	documentVersion(AddressableEntityRef documentVersion)	The version of the document.
boolean	equals(Object o)
KnowledgeSearchDocumentResponse	externalId(String externalId)	The reference to external id associated with the document.
KnowledgeSearchDocumentResponse	externalUrl(String externalUrl)	The URL to external document.
List<KnowledgeDocumentAlternative>	getAlternatives()
String	getAnswer()
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()
KnowledgeSearchDocumentResponse.StateEnum	getState()
String	getTitle()
List<KnowledgeDocumentSearchVariation>	getVariations()
Boolean	getVisible()
int	hashCode()
KnowledgeSearchDocumentResponse	knowledgeBase(KnowledgeBaseReference knowledgeBase)	Knowledge base to which the document belongs to.
KnowledgeSearchDocumentResponse	labels(List<LabelResponse> labels)	The references to labels associated with the document.
KnowledgeSearchDocumentResponse	lastPublishedVersionNumber(Integer lastPublishedVersionNumber)	The last published version number of the document.
KnowledgeSearchDocumentResponse	readonly(Boolean readonly)	Whether the document is read-only.
void	setAlternatives(List<KnowledgeDocumentAlternative> alternatives)
void	setAnswer(String answer)
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(KnowledgeSearchDocumentResponse.StateEnum state)
void	setTitle(String title)
void	setVariations(List<KnowledgeDocumentSearchVariation> variations)
void	setVisible(Boolean visible)
KnowledgeSearchDocumentResponse	source(AddressableEntityRef source)	The reference to source associated with the document.
KnowledgeSearchDocumentResponse	state(KnowledgeSearchDocumentResponse.StateEnum state)	State of the document.
KnowledgeSearchDocumentResponse	title(String title)	Document title, having a limit of 500 words.
String	toString()
KnowledgeSearchDocumentResponse	variations(List<KnowledgeDocumentSearchVariation> variations)	Variations of the document.
KnowledgeSearchDocumentResponse	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

KnowledgeSearchDocumentResponse

public KnowledgeSearchDocumentResponse()

KnowledgeSearchDocumentResponse

public KnowledgeSearchDocumentResponse(Boolean initWithEmptyList)

Method Details

getId

public String getId()

title

public KnowledgeSearchDocumentResponse title(String title)

Document title, having a limit of 500 words.

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

visible

public KnowledgeSearchDocumentResponse 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 KnowledgeSearchDocumentResponse 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 KnowledgeSearchDocumentResponse state(KnowledgeSearchDocumentResponse.StateEnum state)

State of the document.

getState

public KnowledgeSearchDocumentResponse.StateEnum getState()

setState

public void setState(KnowledgeSearchDocumentResponse.StateEnum state)

dateCreated

public KnowledgeSearchDocumentResponse 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 KnowledgeSearchDocumentResponse 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 KnowledgeSearchDocumentResponse 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 KnowledgeSearchDocumentResponse lastPublishedVersionNumber(Integer lastPublishedVersionNumber)

The last published version number of the document.

getLastPublishedVersionNumber

public Integer getLastPublishedVersionNumber()

setLastPublishedVersionNumber

public void setLastPublishedVersionNumber(Integer lastPublishedVersionNumber)

datePublished

public KnowledgeSearchDocumentResponse 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 KnowledgeSearchDocumentResponse documentVersion(AddressableEntityRef documentVersion)

The version of the document.

getDocumentVersion

public AddressableEntityRef getDocumentVersion()

setDocumentVersion

public void setDocumentVersion(AddressableEntityRef documentVersion)

category

public KnowledgeSearchDocumentResponse category(CategoryResponse category)

The reference to category associated with the document.

getCategory

public CategoryResponse getCategory()

setCategory

public void setCategory(CategoryResponse category)

labels

public KnowledgeSearchDocumentResponse 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 KnowledgeSearchDocumentResponse knowledgeBase(KnowledgeBaseReference knowledgeBase)

Knowledge base to which the document belongs to.

getKnowledgeBase

public KnowledgeBaseReference getKnowledgeBase()

setKnowledgeBase

public void setKnowledgeBase(KnowledgeBaseReference knowledgeBase)

externalId

public KnowledgeSearchDocumentResponse externalId(String externalId)

The reference to external id associated with the document.

getExternalId

public String getExternalId()

setExternalId

public void setExternalId(String externalId)

externalUrl

public KnowledgeSearchDocumentResponse externalUrl(String externalUrl)

The URL to external document.

getExternalUrl

public String getExternalUrl()

setExternalUrl

public void setExternalUrl(String externalUrl)

source

public KnowledgeSearchDocumentResponse source(AddressableEntityRef source)

The reference to source associated with the document.

getSource

public AddressableEntityRef getSource()

setSource

public void setSource(AddressableEntityRef source)

readonly

public KnowledgeSearchDocumentResponse readonly(Boolean readonly)

Whether the document is read-only.

getReadonly

public Boolean getReadonly()

setReadonly

public void setReadonly(Boolean readonly)

variations

public KnowledgeSearchDocumentResponse variations(List<KnowledgeDocumentSearchVariation> variations)

Variations of the document.

getVariations

public List<KnowledgeDocumentSearchVariation> getVariations()

setVariations

public void setVariations(List<KnowledgeDocumentSearchVariation> variations)

answer

public KnowledgeSearchDocumentResponse answer(String answer)

The answer to the query.

getAnswer

public String getAnswer()

setAnswer

public void setAnswer(String answer)

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