Package com.mypurecloud.sdk.v2.model

Class KnowledgeGuestSearchDocumentResponse

java.lang.Object

com.mypurecloud.sdk.v2.model.KnowledgeGuestSearchDocumentResponse

All Implemented Interfaces:

Serializable

public class KnowledgeGuestSearchDocumentResponse
extends Object
implements Serializable

KnowledgeGuestSearchDocumentResponse

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
KnowledgeGuestSearchDocumentResponse()
KnowledgeGuestSearchDocumentResponse(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
KnowledgeGuestSearchDocumentResponse	alternatives(List<KnowledgeDocumentAlternative> alternatives)	List of alternate phrases related to the title which improves search results.
KnowledgeGuestSearchDocumentResponse	answer(String answer)	The answer to the query.
KnowledgeGuestSearchDocumentResponse	dateCreated(Date dateCreated)	Document creation date-time.
KnowledgeGuestSearchDocumentResponse	dateImported(Date dateImported)	Document import date-time, or null if was not imported.
KnowledgeGuestSearchDocumentResponse	dateModified(Date dateModified)	Document last modification date-time.
KnowledgeGuestSearchDocumentResponse	datePublished(Date datePublished)	The date on which the document was last published.
KnowledgeGuestSearchDocumentResponse	documentVersion(AddressableEntityRef documentVersion)	The version of the document.
boolean	equals(Object o)
List<KnowledgeDocumentAlternative>	getAlternatives()
String	getAnswer()
GuestCategoryReference	getCategory()
UserReference	getCreatedBy()
Date	getDateCreated()
Date	getDateImported()
Date	getDateModified()
Date	getDatePublished()
AddressableEntityRef	getDocumentVersion()
String	getId()
Integer	getLastPublishedVersionNumber()
UserReference	getModifiedBy()
String	getSelfUri()
String	getSessionId()
KnowledgeGuestSearchDocumentResponse.StateEnum	getState()
String	getTitle()
List<KnowledgeGuestDocumentVariationAnswer>	getVariations()
Boolean	getVisible()
int	hashCode()
KnowledgeGuestSearchDocumentResponse	lastPublishedVersionNumber(Integer lastPublishedVersionNumber)	The last published version number of the document.
void	setAlternatives(List<KnowledgeDocumentAlternative> alternatives)
void	setAnswer(String answer)
void	setDateCreated(Date dateCreated)
void	setDateImported(Date dateImported)
void	setDateModified(Date dateModified)
void	setDatePublished(Date datePublished)
void	setDocumentVersion(AddressableEntityRef documentVersion)
void	setLastPublishedVersionNumber(Integer lastPublishedVersionNumber)
void	setState(KnowledgeGuestSearchDocumentResponse.StateEnum state)
void	setTitle(String title)
void	setVariations(List<KnowledgeGuestDocumentVariationAnswer> variations)
void	setVisible(Boolean visible)
KnowledgeGuestSearchDocumentResponse	state(KnowledgeGuestSearchDocumentResponse.StateEnum state)	State of the document.
KnowledgeGuestSearchDocumentResponse	title(String title)	Document title, having a limit of 500 words.
String	toString()
KnowledgeGuestSearchDocumentResponse	variations(List<KnowledgeGuestDocumentVariationAnswer> variations)	Variations of the document.
KnowledgeGuestSearchDocumentResponse	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

KnowledgeGuestSearchDocumentResponse

public KnowledgeGuestSearchDocumentResponse()

KnowledgeGuestSearchDocumentResponse

public KnowledgeGuestSearchDocumentResponse(Boolean initWithEmptyList)

Method Details

getId

public String getId()

title

public KnowledgeGuestSearchDocumentResponse title(String title)

Document title, having a limit of 500 words.

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

visible

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

State of the document.

getState

public KnowledgeGuestSearchDocumentResponse.StateEnum getState()

setState

public void setState(KnowledgeGuestSearchDocumentResponse.StateEnum state)

dateCreated

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

The last published version number of the document.

getLastPublishedVersionNumber

public Integer getLastPublishedVersionNumber()

setLastPublishedVersionNumber

public void setLastPublishedVersionNumber(Integer lastPublishedVersionNumber)

datePublished

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

The version of the document.

getDocumentVersion

public AddressableEntityRef getDocumentVersion()

setDocumentVersion

public void setDocumentVersion(AddressableEntityRef documentVersion)

getSessionId

public String getSessionId()

getCategory

public GuestCategoryReference getCategory()

variations

public KnowledgeGuestSearchDocumentResponse variations(List<KnowledgeGuestDocumentVariationAnswer> variations)

Variations of the document.

getVariations

public List<KnowledgeGuestDocumentVariationAnswer> getVariations()

setVariations

public void setVariations(List<KnowledgeGuestDocumentVariationAnswer> variations)

answer

public KnowledgeGuestSearchDocumentResponse 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