Package com.docusign.esign.model
Class Folder
- java.lang.Object
-
- com.docusign.esign.model.Folder
-
- All Implemented Interfaces:
Serializable
public class Folder extends Object implements Serializable
This object contains details about a folder..- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Folder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FolderaddFolderItemsItem(FolderItemV2 folderItemsItem)addFolderItemsItem.FolderaddFoldersItem(Folder foldersItem)addFoldersItem.booleanequals(Object o)Compares objects.FoldererrorDetails(ErrorDetails errorDetails)errorDetails.Folderfilter(Filter filter)filter.FolderfolderId(String folderId)folderId.FolderfolderItems(List<FolderItemV2> folderItems)folderItems.Folderfolders(List<Folder> folders)folders.ErrorDetailsgetErrorDetails()Array or errors..FiltergetFilter()An object used to present a filtered view of the items in a folder..StringgetFolderId().List<FolderItemV2>getFolderItems()A list of the envelopes in the specified folder or folders.List<Folder>getFolders()A collection of folder objects returned in a response..StringgetHasAccess().StringgetHasSubFolders().StringgetItemCount().StringgetName().UserInfogetOwner()Information about the user who owns the folder..StringgetParentFolderId().StringgetParentFolderUri().StringgetSubFolderCount().StringgetType().StringgetUri().FolderhasAccess(String hasAccess)hasAccess.inthashCode()Returns the HashCode.FolderhasSubFolders(String hasSubFolders)hasSubFolders.FolderitemCount(String itemCount)itemCount.Foldername(String name)name.Folderowner(UserInfo owner)owner.FolderparentFolderId(String parentFolderId)parentFolderId.FolderparentFolderUri(String parentFolderUri)parentFolderUri.voidsetErrorDetails(ErrorDetails errorDetails)setErrorDetails.voidsetFilter(Filter filter)setFilter.voidsetFolderId(String folderId)setFolderId.voidsetFolderItems(List<FolderItemV2> folderItems)setFolderItems.voidsetFolders(List<Folder> folders)setFolders.voidsetHasAccess(String hasAccess)setHasAccess.voidsetHasSubFolders(String hasSubFolders)setHasSubFolders.voidsetItemCount(String itemCount)setItemCount.voidsetName(String name)setName.voidsetOwner(UserInfo owner)setOwner.voidsetParentFolderId(String parentFolderId)setParentFolderId.voidsetParentFolderUri(String parentFolderUri)setParentFolderUri.voidsetSubFolderCount(String subFolderCount)setSubFolderCount.voidsetType(String type)setType.voidsetUri(String uri)setUri.FoldersubFolderCount(String subFolderCount)subFolderCount.StringtoString()Converts the given object to string.Foldertype(String type)type.Folderuri(String uri)uri.
-
-
-
Method Detail
-
errorDetails
public Folder errorDetails(ErrorDetails errorDetails)
errorDetails.- Returns:
- Folder
-
getErrorDetails
public ErrorDetails getErrorDetails()
Array or errors..- Returns:
- errorDetails
-
setErrorDetails
public void setErrorDetails(ErrorDetails errorDetails)
setErrorDetails.
-
getFilter
public Filter getFilter()
An object used to present a filtered view of the items in a folder..- Returns:
- filter
-
setFilter
public void setFilter(Filter filter)
setFilter.
-
getFolderId
public String getFolderId()
.- Returns:
- folderId
-
setFolderId
public void setFolderId(String folderId)
setFolderId.
-
folderItems
public Folder folderItems(List<FolderItemV2> folderItems)
folderItems.- Returns:
- Folder
-
addFolderItemsItem
public Folder addFolderItemsItem(FolderItemV2 folderItemsItem)
addFolderItemsItem.- Returns:
- Folder
-
getFolderItems
public List<FolderItemV2> getFolderItems()
A list of the envelopes in the specified folder or folders. .- Returns:
- folderItems
-
setFolderItems
public void setFolderItems(List<FolderItemV2> folderItems)
setFolderItems.
-
getFolders
public List<Folder> getFolders()
A collection of folder objects returned in a response..- Returns:
- folders
-
getHasAccess
public String getHasAccess()
.- Returns:
- hasAccess
-
setHasAccess
public void setHasAccess(String hasAccess)
setHasAccess.
-
getHasSubFolders
public String getHasSubFolders()
.- Returns:
- hasSubFolders
-
setHasSubFolders
public void setHasSubFolders(String hasSubFolders)
setHasSubFolders.
-
getItemCount
public String getItemCount()
.- Returns:
- itemCount
-
setItemCount
public void setItemCount(String itemCount)
setItemCount.
-
getName
public String getName()
.- Returns:
- name
-
setName
public void setName(String name)
setName.
-
getOwner
public UserInfo getOwner()
Information about the user who owns the folder..- Returns:
- owner
-
setOwner
public void setOwner(UserInfo owner)
setOwner.
-
getParentFolderId
public String getParentFolderId()
.- Returns:
- parentFolderId
-
setParentFolderId
public void setParentFolderId(String parentFolderId)
setParentFolderId.
-
parentFolderUri
public Folder parentFolderUri(String parentFolderUri)
parentFolderUri.- Returns:
- Folder
-
getParentFolderUri
public String getParentFolderUri()
.- Returns:
- parentFolderUri
-
setParentFolderUri
public void setParentFolderUri(String parentFolderUri)
setParentFolderUri.
-
getSubFolderCount
public String getSubFolderCount()
.- Returns:
- subFolderCount
-
setSubFolderCount
public void setSubFolderCount(String subFolderCount)
setSubFolderCount.
-
getType
public String getType()
.- Returns:
- type
-
setType
public void setType(String type)
setType.
-
getUri
public String getUri()
.- Returns:
- uri
-
setUri
public void setUri(String uri)
setUri.
-
equals
public boolean equals(Object o)
Compares objects.
-
-