com.docusign.esign.model

Class WorkspaceItem

java.lang.Object

com.docusign.esign.model.WorkspaceItem

public class WorkspaceItem
extends Object

A workspaceItem (file type only) representing the file. This property is only returned in response to file specific GET call.

Constructor Summary

Constructors

Constructor and Description
WorkspaceItem()

Method Summary

Methods

Modifier and Type	Method and Description
WorkspaceItem	callerAuthorization(WorkspaceUserAuthorization callerAuthorization)
WorkspaceItem	contentType(String contentType)
WorkspaceItem	created(String created)
WorkspaceItem	createdById(String createdById)
WorkspaceItem	createdByInformation(WorkspaceUser createdByInformation)
boolean	equals(Object o)
WorkspaceItem	extension(String extension)
WorkspaceItem	fileSize(String fileSize)
WorkspaceItem	fileUri(String fileUri)
WorkspaceUserAuthorization	getCallerAuthorization() Get callerAuthorization
String	getContentType()
String	getCreated() The UTC DateTime when the workspace item was created.
String	getCreatedById()
WorkspaceUser	getCreatedByInformation() Get createdByInformation
String	getExtension()
String	getFileSize()
String	getFileUri()
String	getId()
String	getIsPublic() If true, this supersedes need for bit mask permission with workspaceUserAuthorization
String	getLastModified()
String	getLastModifiedById() Utc date and time the comment was last updated (can only be done by creator)
WorkspaceUser	getLastModifiedByInformation() Get lastModifiedByInformation
String	getName() A simple string description of the item, such as a file name or a folder name.
String	getPageCount()
String	getParentFolderId() The ID of the parent folder.
String	getParentFolderUri()
String	getType() The type of the workspace item.
String	getUri()
int	hashCode()
WorkspaceItem	id(String id)
WorkspaceItem	isPublic(String isPublic)
WorkspaceItem	lastModified(String lastModified)
WorkspaceItem	lastModifiedById(String lastModifiedById)
WorkspaceItem	lastModifiedByInformation(WorkspaceUser lastModifiedByInformation)
WorkspaceItem	name(String name)
WorkspaceItem	pageCount(String pageCount)
WorkspaceItem	parentFolderId(String parentFolderId)
WorkspaceItem	parentFolderUri(String parentFolderUri)
void	setCallerAuthorization(WorkspaceUserAuthorization callerAuthorization)
void	setContentType(String contentType)
void	setCreated(String created)
void	setCreatedById(String createdById)
void	setCreatedByInformation(WorkspaceUser createdByInformation)
void	setExtension(String extension)
void	setFileSize(String fileSize)
void	setFileUri(String fileUri)
void	setId(String id)
void	setIsPublic(String isPublic)
void	setLastModified(String lastModified)
void	setLastModifiedById(String lastModifiedById)
void	setLastModifiedByInformation(WorkspaceUser lastModifiedByInformation)
void	setName(String name)
void	setPageCount(String pageCount)
void	setParentFolderId(String parentFolderId)
void	setParentFolderUri(String parentFolderUri)
void	setType(String type)
void	setUri(String uri)
String	toString()
WorkspaceItem	type(String type)
WorkspaceItem	uri(String uri)

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkspaceItem

public WorkspaceItem()

Method Detail

callerAuthorization

public WorkspaceItem callerAuthorization(WorkspaceUserAuthorization callerAuthorization)

getCallerAuthorization

public WorkspaceUserAuthorization getCallerAuthorization()

Get callerAuthorization

Returns:

callerAuthorization

setCallerAuthorization

public void setCallerAuthorization(WorkspaceUserAuthorization callerAuthorization)

contentType

public WorkspaceItem contentType(String contentType)

getContentType

public String getContentType()

Returns:

contentType

setContentType

public void setContentType(String contentType)

created

public WorkspaceItem created(String created)

getCreated

public String getCreated()

The UTC DateTime when the workspace item was created.

Returns:

created

setCreated

public void setCreated(String created)

createdById

public WorkspaceItem createdById(String createdById)

getCreatedById

public String getCreatedById()

Returns:

createdById

setCreatedById

public void setCreatedById(String createdById)

createdByInformation

public WorkspaceItem createdByInformation(WorkspaceUser createdByInformation)

getCreatedByInformation

public WorkspaceUser getCreatedByInformation()

Get createdByInformation

Returns:

createdByInformation

setCreatedByInformation

public void setCreatedByInformation(WorkspaceUser createdByInformation)

extension

public WorkspaceItem extension(String extension)

getExtension

public String getExtension()

Returns:

extension

setExtension

public void setExtension(String extension)

fileSize

public WorkspaceItem fileSize(String fileSize)

getFileSize

public String getFileSize()

Returns:

fileSize

setFileSize

public void setFileSize(String fileSize)

fileUri

public WorkspaceItem fileUri(String fileUri)

getFileUri

public String getFileUri()

Returns:

fileUri

setFileUri

public void setFileUri(String fileUri)

id

public WorkspaceItem id(String id)

getId

public String getId()

Returns:

id

setId

public void setId(String id)

isPublic

public WorkspaceItem isPublic(String isPublic)

getIsPublic

public String getIsPublic()

If true, this supersedes need for bit mask permission with workspaceUserAuthorization

Returns:

isPublic

setIsPublic

public void setIsPublic(String isPublic)

lastModified

public WorkspaceItem lastModified(String lastModified)

getLastModified

public String getLastModified()

Returns:

lastModified

setLastModified

public void setLastModified(String lastModified)

lastModifiedById

public WorkspaceItem lastModifiedById(String lastModifiedById)

getLastModifiedById

public String getLastModifiedById()

Utc date and time the comment was last updated (can only be done by creator)

Returns:

lastModifiedById

setLastModifiedById

public void setLastModifiedById(String lastModifiedById)

lastModifiedByInformation

public WorkspaceItem lastModifiedByInformation(WorkspaceUser lastModifiedByInformation)

getLastModifiedByInformation

public WorkspaceUser getLastModifiedByInformation()

Get lastModifiedByInformation

Returns:

lastModifiedByInformation

setLastModifiedByInformation

public void setLastModifiedByInformation(WorkspaceUser lastModifiedByInformation)

name

public WorkspaceItem name(String name)

getName

public String getName()

A simple string description of the item, such as a file name or a folder name.

Returns:

name

setName

public void setName(String name)

pageCount

public WorkspaceItem pageCount(String pageCount)

getPageCount

public String getPageCount()

Returns:

pageCount

setPageCount

public void setPageCount(String pageCount)

parentFolderId

public WorkspaceItem parentFolderId(String parentFolderId)

getParentFolderId

public String getParentFolderId()

The ID of the parent folder. This is the GUID of the parent folder, or the special value 'root' for the root folder.

Returns:

parentFolderId

setParentFolderId

public void setParentFolderId(String parentFolderId)

parentFolderUri

public WorkspaceItem parentFolderUri(String parentFolderUri)

getParentFolderUri

public String getParentFolderUri()

Returns:

parentFolderUri

setParentFolderUri

public void setParentFolderUri(String parentFolderUri)

type

public WorkspaceItem type(String type)

getType

public String getType()

The type of the workspace item. Valid values are file, folder.

Returns:

type

setType

public void setType(String type)

uri

public WorkspaceItem uri(String uri)

getUri

public String getUri()

Returns:

uri

setUri

public void setUri(String uri)

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