Class RecycleBinDocumentJson
- java.lang.Object
-
- com.blackberry.workspaces.sdk.api.json.BaseJson
-
- com.blackberry.workspaces.sdk.api.json.RecycleBinDocumentJson
-
- All Implemented Interfaces:
Serializable
public class RecycleBinDocumentJson extends BaseJson
A recycle bin file- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description RecycleBinDocumentJson()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DocumentAccessLevel
getAccessLevel()
Access levelString
getContentType()
Content typeDate
getDeleteDate()
Delete dateString
getDeletingUserAddress()
Deleting user email addressDocumentCurrentVersionJson
getDocumentCurrentVersion()
A json which represents the current version of the fileString
getDocumentName()
Use 'name' insteadlong
getDownloadPdfSize()
long
getDownloadSize()
Date
getExpires()
Expires dateString
getFilename()
Name of a file.String
getFolder()
File's folder, for example: /office/docsString
getFolderUuid()
File's folder uuidString
getGuid()
Signed GUID of a file, created by the server.Integer
getId()
IdDate
getLastUpdated()
Date of creation or last update of the file.Date
getLastUpdateDate()
Use 'lastUpdated' insteadString
getName()
NameLong
getOriginalSize()
Original sizeInteger
getPendingRequests()
Pending requestsInteger
getPercentCompleted()
Progress status.PermissionsToUserJson
getPermissionsJson()
Permissions, in some contexts may be null.String
getPreviewUrl()
Preview URLDate
getRecentlyViewed()
not supported any longer - info is meaninglessString
getRoom()
Id of the workspace the file has been submitted to.Float
getScore()
The score of the file in the current searchString
getSender()
Email address of senderStatusJson
getStatus()
Status, status number and error string in case of error.String
getType()
Use 'contentType' insteadString
getUrl()
URL of a (protected) file.String
getWorkspaceName()
Workspace nameboolean
isRead()
Will be true if the last file was read since its last update.boolean
isSecureTransferFile()
Secure transfer fileboolean
isStarred()
Will be true if the file was marked as starred (favorite).void
setAccessLevel(DocumentAccessLevel accessLevel)
Access levelvoid
setContentType(String contentType)
Content typevoid
setDeleteDate(Date deleteDate)
Delete datevoid
setDeletingUserAddress(String deletingUserAddress)
Deleting user email addressvoid
setDocumentCurrentVersion(DocumentCurrentVersionJson documentCurrentVersion)
A json which represents the current version of the filevoid
setDocumentName(String documentName)
Use 'name' insteadvoid
setDownloadPdfSize(long downloadPdfSize)
void
setDownloadSize(long downloadSize)
void
setExpires(Date expires)
Expires datevoid
setFilename(String filename)
Name of a file.void
setFolder(String folder)
File's folder, for example: /office/docsvoid
setFolderUuid(String folderUuid)
File's folder uuidvoid
setGuid(String guid)
Signed GUID of a file, created by the server.void
setId(Integer id)
Idvoid
setLastUpdated(Date lastUpdated)
Date of creation or last update of the file.void
setLastUpdateDate(Date lastUpdateDate)
Use 'lastUpdated' insteadvoid
setName(String name)
Namevoid
setOriginalSize(Long originalSize)
Original sizevoid
setPendingRequests(Integer pendingRequests)
Pending requestsvoid
setPercentCompleted(Integer percentCompleted)
Progress status.void
setPermissionsJson(PermissionsToUserJson permissionsJson)
Permissions, in some contexts may be null.void
setPreviewUrl(String previewUrl)
Preview URLvoid
setRead(boolean read)
Will be true if the last file was read since its last update.void
setRecentlyViewed(Date recentlyViewed)
not supported any longer - info is meaninglessvoid
setRoom(String room)
Id of the workspace the file has been submitted to.void
setScore(Float score)
The score of the file in the current searchvoid
setSecureTransferFile(boolean secureTransferFile)
Secure transfer filevoid
setSender(String sender)
Email address of sendervoid
setStarred(boolean starred)
Will be true if the file was marked as starred (favorite).void
setStatus(StatusJson status)
Status, status number and error string in case of error.void
setType(String type)
Use 'contentType' insteadvoid
setUrl(String url)
URL of a (protected) file.void
setWorkspaceName(String workspaceName)
Workspace name-
Methods inherited from class com.blackberry.workspaces.sdk.api.json.BaseJson
getObjType, setObjType, toString
-
-
-
-
Method Detail
-
getPercentCompleted
public Integer getPercentCompleted()
Progress status.- Returns:
- Progress status.
-
setPercentCompleted
public void setPercentCompleted(Integer percentCompleted)
Progress status.- Parameters:
percentCompleted
- Progress status.
-
getExpires
public Date getExpires()
Expires date- Returns:
- Expires date
-
setExpires
public void setExpires(Date expires)
Expires date- Parameters:
expires
- Expires date
-
getPreviewUrl
public String getPreviewUrl()
Preview URL- Returns:
- Preview URL
-
setPreviewUrl
public void setPreviewUrl(String previewUrl)
Preview URL- Parameters:
previewUrl
- Preview URL
-
getDownloadPdfSize
public long getDownloadPdfSize()
-
setDownloadPdfSize
public void setDownloadPdfSize(long downloadPdfSize)
-
getPendingRequests
public Integer getPendingRequests()
Pending requests- Returns:
- Pending requests
-
setPendingRequests
public void setPendingRequests(Integer pendingRequests)
Pending requests- Parameters:
pendingRequests
- Pending requests
-
getLastUpdateDate
public Date getLastUpdateDate()
Use 'lastUpdated' instead- Returns:
- Use 'lastUpdated' instead
-
setLastUpdateDate
public void setLastUpdateDate(Date lastUpdateDate)
Use 'lastUpdated' instead- Parameters:
lastUpdateDate
- Use 'lastUpdated' instead
-
getType
public String getType()
Use 'contentType' instead- Returns:
- Use 'contentType' instead
-
setType
public void setType(String type)
Use 'contentType' instead- Parameters:
type
- Use 'contentType' instead
-
getScore
public Float getScore()
The score of the file in the current search- Returns:
- The score of the file in the current search
-
setScore
public void setScore(Float score)
The score of the file in the current search- Parameters:
score
- The score of the file in the current search
-
getLastUpdated
public Date getLastUpdated()
Date of creation or last update of the file.- Returns:
- Date of creation or last update of the file.
-
setLastUpdated
public void setLastUpdated(Date lastUpdated)
Date of creation or last update of the file.- Parameters:
lastUpdated
- Date of creation or last update of the file.
-
isStarred
public boolean isStarred()
Will be true if the file was marked as starred (favorite).- Returns:
- Will be true if the file was marked as starred (favorite).
-
setStarred
public void setStarred(boolean starred)
Will be true if the file was marked as starred (favorite).- Parameters:
starred
- Will be true if the file was marked as starred (favorite).
-
getWorkspaceName
public String getWorkspaceName()
Workspace name- Returns:
- Workspace name
-
setWorkspaceName
public void setWorkspaceName(String workspaceName)
Workspace name- Parameters:
workspaceName
- Workspace name
-
getId
public Integer getId()
Id- Returns:
- Id
-
setId
public void setId(Integer id)
Id- Parameters:
id
- Id
-
getOriginalSize
public Long getOriginalSize()
Original size- Returns:
- Original size
-
setOriginalSize
public void setOriginalSize(Long originalSize)
Original size- Parameters:
originalSize
- Original size
-
getContentType
public String getContentType()
Content type- Returns:
- Content type
-
setContentType
public void setContentType(String contentType)
Content type- Parameters:
contentType
- Content type
-
getDeletingUserAddress
public String getDeletingUserAddress()
Deleting user email address- Returns:
- Deleting user email address
-
setDeletingUserAddress
public void setDeletingUserAddress(String deletingUserAddress)
Deleting user email address- Parameters:
deletingUserAddress
- Deleting user email address
-
getDeleteDate
public Date getDeleteDate()
Delete date- Returns:
- Delete date
-
setDeleteDate
public void setDeleteDate(Date deleteDate)
Delete date- Parameters:
deleteDate
- Delete date
-
isRead
public boolean isRead()
Will be true if the last file was read since its last update.- Returns:
- Will be true if the last file was read since its last update.
-
setRead
public void setRead(boolean read)
Will be true if the last file was read since its last update.- Parameters:
read
- Will be true if the last file was read since its last update.
-
getAccessLevel
public DocumentAccessLevel getAccessLevel()
Access level- Returns:
- Access level
-
setAccessLevel
public void setAccessLevel(DocumentAccessLevel accessLevel)
Access level- Parameters:
accessLevel
- Access level
-
isSecureTransferFile
public boolean isSecureTransferFile()
Secure transfer file- Returns:
- Secure transfer file
-
setSecureTransferFile
public void setSecureTransferFile(boolean secureTransferFile)
Secure transfer file- Parameters:
secureTransferFile
- Secure transfer file
-
getDocumentName
public String getDocumentName()
Use 'name' instead- Returns:
- Use 'name' instead
-
setDocumentName
public void setDocumentName(String documentName)
Use 'name' instead- Parameters:
documentName
- Use 'name' instead
-
getPermissionsJson
public PermissionsToUserJson getPermissionsJson()
Permissions, in some contexts may be null.- Returns:
- Permissions, in some contexts may be null.
-
setPermissionsJson
public void setPermissionsJson(PermissionsToUserJson permissionsJson)
Permissions, in some contexts may be null.- Parameters:
permissionsJson
- Permissions, in some contexts may be null.
-
getFolderUuid
public String getFolderUuid()
File's folder uuid- Returns:
- File's folder uuid
-
setFolderUuid
public void setFolderUuid(String folderUuid)
File's folder uuid- Parameters:
folderUuid
- File's folder uuid
-
getDocumentCurrentVersion
public DocumentCurrentVersionJson getDocumentCurrentVersion()
A json which represents the current version of the file- Returns:
- A json which represents the current version of the file
-
setDocumentCurrentVersion
public void setDocumentCurrentVersion(DocumentCurrentVersionJson documentCurrentVersion)
A json which represents the current version of the file- Parameters:
documentCurrentVersion
- A json which represents the current version of the file
-
getRoom
public String getRoom()
Id of the workspace the file has been submitted to.- Returns:
- Id of the workspace the file has been submitted to.
-
setRoom
public void setRoom(String room)
Id of the workspace the file has been submitted to.- Parameters:
room
- Id of the workspace the file has been submitted to.
-
getUrl
public String getUrl()
URL of a (protected) file.- Returns:
- URL of a (protected) file.
-
setUrl
public void setUrl(String url)
URL of a (protected) file.- Parameters:
url
- URL of a (protected) file.
-
getRecentlyViewed
public Date getRecentlyViewed()
not supported any longer - info is meaningless- Returns:
- not supported any longer - info is meaningless
-
setRecentlyViewed
public void setRecentlyViewed(Date recentlyViewed)
not supported any longer - info is meaningless- Parameters:
recentlyViewed
- not supported any longer - info is meaningless
-
getFilename
public String getFilename()
Name of a file.- Returns:
- Name of a file.
-
setFilename
public void setFilename(String filename)
Name of a file.- Parameters:
filename
- Name of a file.
-
getFolder
public String getFolder()
File's folder, for example: /office/docs- Returns:
- File's folder, for example: /office/docs
-
setFolder
public void setFolder(String folder)
File's folder, for example: /office/docs- Parameters:
folder
- File's folder, for example: /office/docs
-
getDownloadSize
public long getDownloadSize()
-
setDownloadSize
public void setDownloadSize(long downloadSize)
-
getSender
public String getSender()
Email address of sender- Returns:
- Email address of sender
-
setSender
public void setSender(String sender)
Email address of sender- Parameters:
sender
- Email address of sender
-
getName
public String getName()
Name- Returns:
- Name
-
setName
public void setName(String name)
Name- Parameters:
name
- Name
-
getGuid
public String getGuid()
Signed GUID of a file, created by the server.- Returns:
- Signed GUID of a file, created by the server.
-
setGuid
public void setGuid(String guid)
Signed GUID of a file, created by the server.- Parameters:
guid
- Signed GUID of a file, created by the server.
-
getStatus
public StatusJson getStatus()
Status, status number and error string in case of error.- Returns:
- Status, status number and error string in case of error.
-
setStatus
public void setStatus(StatusJson status)
Status, status number and error string in case of error.- Parameters:
status
- Status, status number and error string in case of error.
-
-