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
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 nameMethods inherited from class com.blackberry.workspaces.sdk.api.json.BaseJson
getObjType, setObjType, toString
-
Constructor Details
-
RecycleBinDocumentJson
public RecycleBinDocumentJson()
-
-
Method Details
-
getPercentCompleted
Progress status.- Returns:
- Progress status.
-
setPercentCompleted
Progress status.- Parameters:
percentCompleted
- Progress status.
-
getExpires
Expires date- Returns:
- Expires date
-
setExpires
Expires date- Parameters:
expires
- Expires date
-
getPreviewUrl
Preview URL- Returns:
- Preview URL
-
setPreviewUrl
Preview URL- Parameters:
previewUrl
- Preview URL
-
getDownloadPdfSize
public long getDownloadPdfSize() -
setDownloadPdfSize
public void setDownloadPdfSize(long downloadPdfSize) -
getPendingRequests
Pending requests- Returns:
- Pending requests
-
setPendingRequests
Pending requests- Parameters:
pendingRequests
- Pending requests
-
getLastUpdateDate
Use 'lastUpdated' instead- Returns:
- Use 'lastUpdated' instead
-
setLastUpdateDate
Use 'lastUpdated' instead- Parameters:
lastUpdateDate
- Use 'lastUpdated' instead
-
getType
Use 'contentType' instead- Returns:
- Use 'contentType' instead
-
setType
Use 'contentType' instead- Parameters:
type
- Use 'contentType' instead
-
getScore
The score of the file in the current search- Returns:
- The score of the file in the current search
-
setScore
The score of the file in the current search- Parameters:
score
- The score of the file in the current search
-
getLastUpdated
Date of creation or last update of the file.- Returns:
- Date of creation or last update of the file.
-
setLastUpdated
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
Workspace name- Returns:
- Workspace name
-
setWorkspaceName
Workspace name- Parameters:
workspaceName
- Workspace name
-
getId
Id- Returns:
- Id
-
setId
Id- Parameters:
id
- Id
-
getOriginalSize
Original size- Returns:
- Original size
-
setOriginalSize
Original size- Parameters:
originalSize
- Original size
-
getContentType
Content type- Returns:
- Content type
-
setContentType
Content type- Parameters:
contentType
- Content type
-
getDeletingUserAddress
Deleting user email address- Returns:
- Deleting user email address
-
setDeletingUserAddress
Deleting user email address- Parameters:
deletingUserAddress
- Deleting user email address
-
getDeleteDate
Delete date- Returns:
- Delete date
-
setDeleteDate
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
Access level- Returns:
- Access level
-
setAccessLevel
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
Use 'name' instead- Returns:
- Use 'name' instead
-
setDocumentName
Use 'name' instead- Parameters:
documentName
- Use 'name' instead
-
getFolderUuid
File's folder uuid- Returns:
- File's folder uuid
-
setFolderUuid
File's folder uuid- Parameters:
folderUuid
- File's folder uuid
-
getPermissionsJson
Permissions, in some contexts may be null.- Returns:
- Permissions, in some contexts may be null.
-
setPermissionsJson
Permissions, in some contexts may be null.- Parameters:
permissionsJson
- Permissions, in some contexts may be null.
-
getDocumentCurrentVersion
A json which represents the current version of the file- Returns:
- A json which represents the current version of the file
-
setDocumentCurrentVersion
A json which represents the current version of the file- Parameters:
documentCurrentVersion
- A json which represents the current version of the file
-
getUrl
URL of a (protected) file.- Returns:
- URL of a (protected) file.
-
setUrl
URL of a (protected) file.- Parameters:
url
- URL of a (protected) file.
-
getRoom
Id of the workspace the file has been submitted to.- Returns:
- Id of the workspace the file has been submitted to.
-
setRoom
Id of the workspace the file has been submitted to.- Parameters:
room
- Id of the workspace the file has been submitted to.
-
getRecentlyViewed
not supported any longer - info is meaningless- Returns:
- not supported any longer - info is meaningless
-
setRecentlyViewed
not supported any longer - info is meaningless- Parameters:
recentlyViewed
- not supported any longer - info is meaningless
-
getFilename
Name of a file.- Returns:
- Name of a file.
-
setFilename
Name of a file.- Parameters:
filename
- Name of a file.
-
getFolder
File's folder, for example: /office/docs- Returns:
- File's folder, for example: /office/docs
-
setFolder
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
Email address of sender- Returns:
- Email address of sender
-
setSender
Email address of sender- Parameters:
sender
- Email address of sender
-
getName
Name- Returns:
- Name
-
setName
Name- Parameters:
name
- Name
-
getGuid
Signed GUID of a file, created by the server.- Returns:
- Signed GUID of a file, created by the server.
-
setGuid
Signed GUID of a file, created by the server.- Parameters:
guid
- Signed GUID of a file, created by the server.
-
getStatus
Status, status number and error string in case of error.- Returns:
- Status, status number and error string in case of error.
-
setStatus
Status, status number and error string in case of error.- Parameters:
status
- Status, status number and error string in case of error.
-