Package com.mypurecloud.sdk.v2.model

Class Document

java.lang.Object

com.mypurecloud.sdk.v2.model.Document

All Implemented Interfaces:

Serializable

public class Document
extends Object
implements Serializable

Document

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Document.SharingStatusEnum	Gets or Sets sharingStatus
static enum	Document.SystemTypeEnum	Gets or Sets systemType
static enum	Document.UploadMethodEnum	Gets or Sets uploadMethod

Constructor Summary

Constructors

Constructor	Description
Document()
Document(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
Document	acl(List<String> acl)	A list of permitted action rights for the user making the request
Document	attributes(List<DocumentAttribute> attributes)
Document	callerAddress(String callerAddress)
Document	changeNumber(Integer changeNumber)
Document	contentLength(Long contentLength)
Document	contentType(String contentType)
Document	contentUri(String contentUri)
Document	createdBy(DomainEntityRef createdBy)
Document	dateCreated(Date dateCreated)	Date time is represented as an ISO-8601 string.
Document	dateModified(Date dateModified)	Date time is represented as an ISO-8601 string.
Document	dateUploaded(Date dateUploaded)	Date time is represented as an ISO-8601 string.
Document	downloadSharingUri(String downloadSharingUri)
boolean	equals(Object o)
Document	filename(String filename)
List<String>	getAcl()
List<DocumentAttribute>	getAttributes()
String	getCallerAddress()
Integer	getChangeNumber()
Long	getContentLength()
String	getContentType()
String	getContentUri()
DomainEntityRef	getCreatedBy()
Date	getDateCreated()
Date	getDateModified()
Date	getDateUploaded()
String	getDownloadSharingUri()
String	getFilename()
String	getId()
LockInfo	getLockInfo()
String	getName()
Long	getPageCount()
Boolean	getRead()
String	getReceiverAddress()
String	getSelfUri()
Document.SharingStatusEnum	getSharingStatus()
String	getSharingUri()
Document.SystemTypeEnum	getSystemType()
List<String>	getTags()
List<TagValue>	getTagValues()
List<DocumentThumbnail>	getThumbnails()
String	getUploadDestinationUri()
DomainEntityRef	getUploadedBy()
Document.UploadMethodEnum	getUploadMethod()
DomainEntityRef	getUploadStatus()
DomainEntityRef	getWorkspace()
int	hashCode()
Document	lockInfo(LockInfo lockInfo)
Document	name(String name)
Document	pageCount(Long pageCount)
Document	read(Boolean read)
Document	receiverAddress(String receiverAddress)
void	setAcl(List<String> acl)
void	setAttributes(List<DocumentAttribute> attributes)
void	setCallerAddress(String callerAddress)
void	setChangeNumber(Integer changeNumber)
void	setContentLength(Long contentLength)
void	setContentType(String contentType)
void	setContentUri(String contentUri)
void	setCreatedBy(DomainEntityRef createdBy)
void	setDateCreated(Date dateCreated)
void	setDateModified(Date dateModified)
void	setDateUploaded(Date dateUploaded)
void	setDownloadSharingUri(String downloadSharingUri)
void	setFilename(String filename)
void	setLockInfo(LockInfo lockInfo)
void	setName(String name)
void	setPageCount(Long pageCount)
void	setRead(Boolean read)
void	setReceiverAddress(String receiverAddress)
void	setSharingStatus(Document.SharingStatusEnum sharingStatus)
void	setSharingUri(String sharingUri)
void	setSystemType(Document.SystemTypeEnum systemType)
void	setTags(List<String> tags)
void	setTagValues(List<TagValue> tagValues)
void	setThumbnails(List<DocumentThumbnail> thumbnails)
void	setUploadDestinationUri(String uploadDestinationUri)
void	setUploadedBy(DomainEntityRef uploadedBy)
void	setUploadMethod(Document.UploadMethodEnum uploadMethod)
void	setUploadStatus(DomainEntityRef uploadStatus)
void	setWorkspace(DomainEntityRef workspace)
Document	sharingStatus(Document.SharingStatusEnum sharingStatus)
Document	sharingUri(String sharingUri)
Document	systemType(Document.SystemTypeEnum systemType)
Document	tags(List<String> tags)
Document	tagValues(List<TagValue> tagValues)
Document	thumbnails(List<DocumentThumbnail> thumbnails)
String	toString()
Document	uploadDestinationUri(String uploadDestinationUri)
Document	uploadedBy(DomainEntityRef uploadedBy)
Document	uploadMethod(Document.UploadMethodEnum uploadMethod)
Document	uploadStatus(DomainEntityRef uploadStatus)
Document	workspace(DomainEntityRef workspace)

Methods inherited from class java.lang.Object

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

Constructor Details

Document

public Document()

Document

public Document(Boolean initWithEmptyList)

Method Details

getId

public String getId()

name

public Document name(String name)

getName

public String getName()

setName

public void setName(String name)

changeNumber

public Document changeNumber(Integer changeNumber)

getChangeNumber

public Integer getChangeNumber()

setChangeNumber

public void setChangeNumber(Integer changeNumber)

dateCreated

public Document dateCreated(Date dateCreated)

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 Document dateModified(Date dateModified)

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)

dateUploaded

public Document dateUploaded(Date dateUploaded)

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

getDateUploaded

public Date getDateUploaded()

setDateUploaded

public void setDateUploaded(Date dateUploaded)

contentUri

public Document contentUri(String contentUri)

getContentUri

public String getContentUri()

setContentUri

public void setContentUri(String contentUri)

workspace

public Document workspace(DomainEntityRef workspace)

getWorkspace

public DomainEntityRef getWorkspace()

setWorkspace

public void setWorkspace(DomainEntityRef workspace)

createdBy

public Document createdBy(DomainEntityRef createdBy)

getCreatedBy

public DomainEntityRef getCreatedBy()

setCreatedBy

public void setCreatedBy(DomainEntityRef createdBy)

uploadedBy

public Document uploadedBy(DomainEntityRef uploadedBy)

getUploadedBy

public DomainEntityRef getUploadedBy()

setUploadedBy

public void setUploadedBy(DomainEntityRef uploadedBy)

sharingUri

public Document sharingUri(String sharingUri)

getSharingUri

public String getSharingUri()

setSharingUri

public void setSharingUri(String sharingUri)

contentType

public Document contentType(String contentType)

getContentType

public String getContentType()

setContentType

public void setContentType(String contentType)

contentLength

public Document contentLength(Long contentLength)

getContentLength

public Long getContentLength()

setContentLength

public void setContentLength(Long contentLength)

systemType

public Document systemType(Document.SystemTypeEnum systemType)

getSystemType

public Document.SystemTypeEnum getSystemType()

setSystemType

public void setSystemType(Document.SystemTypeEnum systemType)

filename

public Document filename(String filename)

getFilename

public String getFilename()

setFilename

public void setFilename(String filename)

pageCount

public Document pageCount(Long pageCount)

getPageCount

public Long getPageCount()

setPageCount

public void setPageCount(Long pageCount)

read

public Document read(Boolean read)

getRead

public Boolean getRead()

setRead

public void setRead(Boolean read)

callerAddress

public Document callerAddress(String callerAddress)

getCallerAddress

public String getCallerAddress()

setCallerAddress

public void setCallerAddress(String callerAddress)

receiverAddress

public Document receiverAddress(String receiverAddress)

getReceiverAddress

public String getReceiverAddress()

setReceiverAddress

public void setReceiverAddress(String receiverAddress)

tags

public Document tags(List<String> tags)

getTags

public List<String> getTags()

setTags

public void setTags(List<String> tags)

tagValues

public Document tagValues(List<TagValue> tagValues)

getTagValues

public List<TagValue> getTagValues()

setTagValues

public void setTagValues(List<TagValue> tagValues)

attributes

public Document attributes(List<DocumentAttribute> attributes)

getAttributes

public List<DocumentAttribute> getAttributes()

setAttributes

public void setAttributes(List<DocumentAttribute> attributes)

thumbnails

public Document thumbnails(List<DocumentThumbnail> thumbnails)

getThumbnails

public List<DocumentThumbnail> getThumbnails()

setThumbnails

public void setThumbnails(List<DocumentThumbnail> thumbnails)

uploadStatus

public Document uploadStatus(DomainEntityRef uploadStatus)

getUploadStatus

public DomainEntityRef getUploadStatus()

setUploadStatus

public void setUploadStatus(DomainEntityRef uploadStatus)

uploadDestinationUri

public Document uploadDestinationUri(String uploadDestinationUri)

getUploadDestinationUri

public String getUploadDestinationUri()

setUploadDestinationUri

public void setUploadDestinationUri(String uploadDestinationUri)

uploadMethod

public Document uploadMethod(Document.UploadMethodEnum uploadMethod)

getUploadMethod

public Document.UploadMethodEnum getUploadMethod()

setUploadMethod

public void setUploadMethod(Document.UploadMethodEnum uploadMethod)

lockInfo

public Document lockInfo(LockInfo lockInfo)

getLockInfo

public LockInfo getLockInfo()

setLockInfo

public void setLockInfo(LockInfo lockInfo)

acl

public Document acl(List<String> acl)

A list of permitted action rights for the user making the request

getAcl

public List<String> getAcl()

setAcl

public void setAcl(List<String> acl)

sharingStatus

public Document sharingStatus(Document.SharingStatusEnum sharingStatus)

getSharingStatus

public Document.SharingStatusEnum getSharingStatus()

setSharingStatus

public void setSharingStatus(Document.SharingStatusEnum sharingStatus)

downloadSharingUri

public Document downloadSharingUri(String downloadSharingUri)

getDownloadSharingUri

public String getDownloadSharingUri()

setDownloadSharingUri

public void setDownloadSharingUri(String downloadSharingUri)

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