Package com.mypurecloud.sdk.v2.model

Class KnowledgeGuestDocumentResponse

java.lang.Object

com.mypurecloud.sdk.v2.model.KnowledgeGuestDocumentResponse

All Implemented Interfaces:

Serializable

public class KnowledgeGuestDocumentResponse
extends Object
implements Serializable

KnowledgeGuestDocumentResponse

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
KnowledgeGuestDocumentResponse()
KnowledgeGuestDocumentResponse(Boolean initWithEmptyList)

Method Summary

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

KnowledgeGuestDocumentResponse

public KnowledgeGuestDocumentResponse()

KnowledgeGuestDocumentResponse

public KnowledgeGuestDocumentResponse(Boolean initWithEmptyList)

Method Details

getId

public String getId()

title

public KnowledgeGuestDocumentResponse title(String title)

Document title, having a limit of 500 words.

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

visible

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

State of the document.

getState

public KnowledgeGuestDocumentResponse.StateEnum getState()

setState

public void setState(KnowledgeGuestDocumentResponse.StateEnum state)

dateCreated

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

The last published version number of the document.

getLastPublishedVersionNumber

public Integer getLastPublishedVersionNumber()

setLastPublishedVersionNumber

public void setLastPublishedVersionNumber(Integer lastPublishedVersionNumber)

datePublished

public KnowledgeGuestDocumentResponse 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 KnowledgeGuestDocumentResponse 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 KnowledgeGuestDocumentResponse variations(List<KnowledgeGuestDocumentVariation> variations)

Variations of the document.

getVariations

public List<KnowledgeGuestDocumentVariation> getVariations()

setVariations

public void setVariations(List<KnowledgeGuestDocumentVariation> 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