Class TransientDocumentJson
- java.lang.Object
-
- com.blackberry.workspaces.api.sdk.json.BaseJson
-
- com.blackberry.workspaces.api.sdk.json.TransientDocumentJson
-
- All Implemented Interfaces:
Serializable
public class TransientDocumentJson extends BaseJson
Details for a file in a transient workspace- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description TransientDocumentJson()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DocumentAccessLevel
getAccessLevel()
Document Access Level.DocumentAnnotationsListJson
getAnnotationsList()
A json which represents the users who annotated the file, and the last update date of their annotationCacheDocumentStatus
getCacheStatus()
Cache statusString
getClassification()
Classification, if exists.String
getContentType()
Content typeString
getConvertedName()
Converted name for fileDate
getCreationDate()
Date of creation.String
getDlpStatus()
return the DLP status of an uploading documentDocumentCurrentVersionJson
getDocumentCurrentVersion()
A json which represents the current version of the fileString
getDocumentName()
Use 'name' insteadLong
getDownloadPdfSize()
Long
getDownloadSize()
String
getEditorUrl()
URL to edit the document using WopiDate
getExpires()
Use permissions insteadDocumentExternalRepositoryDataJson
getExternalRepositoryData()
String
getFileHash()
File hashString
getFilename()
File name.String
getFolder()
File's folder, for example: /office/docsString
getFolderDisplay()
The display value of folder.Integer
getFolderId()
Folder idString
getFolderUuid()
Folder uuidBoolean
getInheritsPerms()
Inherits permissionsDate
getLastUpdated()
Date of creation or last update of the file.Date
getLastUpdateDate()
Use 'lastUpdated' insteadInteger
getLicenseHoursValid()
Max hours that the license is validString
getModifiedBy()
Modified byDate
getModifiedDate()
Date of modified.String
getName()
File nameInteger
getNumOfVersions()
Indicates how many versions this file hasString
getOnlineEditorUrl()
URL to edit the file onlineBoolean
getOpenToAnyone()
Indicates that the file can be accessed by non-authenticated usersLong
getOriginalSize()
Original size of file (bytes)String
getPath()
Path of the file in the transient external repositoryPdfConversionStatus
getPdfConversionStatus()
The status of PDF conversionInteger
getPendingRequests()
Number of pending requests to access the fileInteger
getPercentCompleted()
Progress status.PermissionsToUserJson
getPermissionsJson()
Permissions, in some contexts may be null.String
getPreviewUrl()
URL to preview the fileBoolean
getRead()
Will be true if the last file was read since its last update.ReadyForDownloadOriginal
getReadyForDownloadOriginal()
Read only when file is cached and download vlp validation is over (if necessary)Boolean
getRmsEnabled()
RMS enabledString
getRoom()
Id of the workspace the file has been submitted to.Float
getScore()
The score of the file in the current searchBoolean
getSecureTransferFile()
Secure transfer fileString
getSender()
Sender's email addressBoolean
getStarred()
Will be true if the file was marked as starred (favorite).Date
getStarredDate()
Mark dateStatusJson
getStatus()
Status, status number and error string in case of error.Boolean
getSupportedFileType()
Indicates that a file can be shown in Watchdox Online ViewerTagListJson
getTagList()
Tags, if exist.TransientDocumentCommentCountJson
getTransientDocumentCommentCountJson()
Comments countString
getType()
Use 'contentType' insteadString
getUrl()
URL of a (protected) file.String
getViewerUrl()
URL of a (protected) file for viewing .String
getWorkspaceUuid()
Workspace uuidvoid
setAccessLevel(DocumentAccessLevel accessLevel)
Document Access Level.void
setAnnotationsList(DocumentAnnotationsListJson annotationsList)
A json which represents the users who annotated the file, and the last update date of their annotationvoid
setCacheStatus(CacheDocumentStatus cacheStatus)
Cache statusvoid
setClassification(String classification)
Classification, if exists.void
setContentType(String contentType)
Content typevoid
setConvertedName(String convertedName)
Converted name for filevoid
setCreationDate(Date creationDate)
Date of creation.void
setDlpStatus(String dlpStatus)
return the DLP status of an uploading documentvoid
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
setEditorUrl(String editorUrl)
URL to edit the document using Wopivoid
setExpires(Date expires)
Use permissions insteadvoid
setExternalRepositoryData(DocumentExternalRepositoryDataJson externalRepositoryData)
void
setFileHash(String fileHash)
File hashvoid
setFilename(String filename)
File name.void
setFolder(String folder)
File's folder, for example: /office/docsvoid
setFolderDisplay(String folderDisplay)
The display value of folder.void
setFolderId(Integer folderId)
Folder idvoid
setFolderUuid(String folderUuid)
Folder uuidvoid
setInheritsPerms(Boolean inheritsPerms)
Inherits permissionsvoid
setLastUpdated(Date lastUpdated)
Date of creation or last update of the file.void
setLastUpdateDate(Date lastUpdateDate)
Use 'lastUpdated' insteadvoid
setLicenseHoursValid(Integer licenseHoursValid)
Max hours that the license is validvoid
setModifiedBy(String modifiedBy)
Modified byvoid
setModifiedDate(Date modifiedDate)
Date of modified.void
setName(String name)
File namevoid
setNumOfVersions(Integer numOfVersions)
Indicates how many versions this file hasvoid
setOnlineEditorUrl(String onlineEditorUrl)
URL to edit the file onlinevoid
setOpenToAnyone(Boolean openToAnyone)
Indicates that the file can be accessed by non-authenticated usersvoid
setOriginalSize(Long originalSize)
Original size of file (bytes)void
setPath(String path)
Path of the file in the transient external repositoryvoid
setPdfConversionStatus(PdfConversionStatus pdfConversionStatus)
The status of PDF conversionvoid
setPendingRequests(Integer pendingRequests)
Number of pending requests to access the filevoid
setPercentCompleted(Integer percentCompleted)
Progress status.void
setPermissionsJson(PermissionsToUserJson permissionsJson)
Permissions, in some contexts may be null.void
setPreviewUrl(String previewUrl)
URL to preview the filevoid
setRead(Boolean read)
Will be true if the last file was read since its last update.void
setReadyForDownloadOriginal(ReadyForDownloadOriginal readyForDownloadOriginal)
Read only when file is cached and download vlp validation is over (if necessary)void
setRmsEnabled(Boolean rmsEnabled)
RMS enabledvoid
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)
Sender's email addressvoid
setStarred(Boolean starred)
Will be true if the file was marked as starred (favorite).void
setStarredDate(Date starredDate)
Mark datevoid
setStatus(StatusJson status)
Status, status number and error string in case of error.void
setSupportedFileType(Boolean supportedFileType)
Indicates that a file can be shown in Watchdox Online Viewervoid
setTagList(TagListJson tagList)
Tags, if exist.void
setTransientDocumentCommentCountJson(TransientDocumentCommentCountJson transientDocumentCommentCountJson)
Comments countvoid
setType(String type)
Use 'contentType' insteadvoid
setUrl(String url)
URL of a (protected) file.void
setViewerUrl(String viewerUrl)
URL of a (protected) file for viewing .void
setWorkspaceUuid(String workspaceUuid)
Workspace uuid-
Methods inherited from class com.blackberry.workspaces.api.sdk.json.BaseJson
getObjType, setObjType, toString
-
-
-
-
Method Detail
-
getPreviewUrl
public String getPreviewUrl()
URL to preview the file- Returns:
- URL to preview the file
-
setPreviewUrl
public void setPreviewUrl(String previewUrl)
URL to preview the file- Parameters:
previewUrl
- URL to preview the file
-
getPendingRequests
public Integer getPendingRequests()
Number of pending requests to access the file- Returns:
- Number of pending requests to access the file
-
setPendingRequests
public void setPendingRequests(Integer pendingRequests)
Number of pending requests to access the file- Parameters:
pendingRequests
- Number of pending requests to access the file
-
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
-
getFileHash
public String getFileHash()
File hash- Returns:
- File hash
-
setFileHash
public void setFileHash(String fileHash)
File hash- Parameters:
fileHash
- File hash
-
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
-
getPath
public String getPath()
Path of the file in the transient external repository- Returns:
- Path of the file in the transient external repository
-
setPath
public void setPath(String path)
Path of the file in the transient external repository- Parameters:
path
- Path of the file in the transient external repository
-
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.
-
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
-
getStarred
public Boolean getStarred()
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).
-
getReadyForDownloadOriginal
public ReadyForDownloadOriginal getReadyForDownloadOriginal()
Read only when file is cached and download vlp validation is over (if necessary)- Returns:
- Read only when file is cached and download vlp validation is over (if necessary)
-
setReadyForDownloadOriginal
public void setReadyForDownloadOriginal(ReadyForDownloadOriginal readyForDownloadOriginal)
Read only when file is cached and download vlp validation is over (if necessary)- Parameters:
readyForDownloadOriginal
- Read only when file is cached and download vlp validation is over (if necessary)
-
getExternalRepositoryData
public DocumentExternalRepositoryDataJson getExternalRepositoryData()
-
setExternalRepositoryData
public void setExternalRepositoryData(DocumentExternalRepositoryDataJson externalRepositoryData)
-
getOriginalSize
public Long getOriginalSize()
Original size of file (bytes)- Returns:
- Original size of file (bytes)
-
setOriginalSize
public void setOriginalSize(Long originalSize)
Original size of file (bytes)- Parameters:
originalSize
- Original size of file (bytes)
-
getContentType
public String getContentType()
Content type- Returns:
- Content type
-
setContentType
public void setContentType(String contentType)
Content type- Parameters:
contentType
- Content type
-
getRead
public Boolean getRead()
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.
-
getSecureTransferFile
public Boolean getSecureTransferFile()
Secure transfer file- Returns:
- Secure transfer file
-
setSecureTransferFile
public void setSecureTransferFile(Boolean secureTransferFile)
Secure transfer file- Parameters:
secureTransferFile
- Secure transfer file
-
getCacheStatus
public CacheDocumentStatus getCacheStatus()
Cache status- Returns:
- Cache status
-
setCacheStatus
public void setCacheStatus(CacheDocumentStatus cacheStatus)
Cache status- Parameters:
cacheStatus
- Cache status
-
getCreationDate
public Date getCreationDate()
Date of creation.- Returns:
- Date of creation.
-
setCreationDate
public void setCreationDate(Date creationDate)
Date of creation.- Parameters:
creationDate
- Date of creation.
-
getClassification
public String getClassification()
Classification, if exists.- Returns:
- Classification, if exists.
-
setClassification
public void setClassification(String classification)
Classification, if exists.- Parameters:
classification
- Classification, if exists.
-
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
-
getFolderId
public Integer getFolderId()
Folder id- Returns:
- Folder id
-
setFolderId
public void setFolderId(Integer folderId)
Folder id- Parameters:
folderId
- Folder id
-
getDownloadSize
public Long getDownloadSize()
-
setDownloadSize
public void setDownloadSize(Long downloadSize)
-
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
-
getFilename
public String getFilename()
File name.- Returns:
- File name.
-
setFilename
public void setFilename(String filename)
File name.- Parameters:
filename
- File name.
-
getSender
public String getSender()
Sender's email address- Returns:
- Sender's email address
-
setSender
public void setSender(String sender)
Sender's email address- Parameters:
sender
- Sender's email address
-
getName
public String getName()
File name- Returns:
- File name
-
setName
public void setName(String name)
File name- Parameters:
name
- File name
-
getModifiedDate
public Date getModifiedDate()
Date of modified.- Returns:
- Date of modified.
-
setModifiedDate
public void setModifiedDate(Date modifiedDate)
Date of modified.- Parameters:
modifiedDate
- Date of modified.
-
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.
-
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()
Use permissions instead- Returns:
- Use permissions instead
-
setExpires
public void setExpires(Date expires)
Use permissions instead- Parameters:
expires
- Use permissions instead
-
getDownloadPdfSize
public Long getDownloadPdfSize()
-
setDownloadPdfSize
public void setDownloadPdfSize(Long downloadPdfSize)
-
getOnlineEditorUrl
public String getOnlineEditorUrl()
URL to edit the file online- Returns:
- URL to edit the file online
-
setOnlineEditorUrl
public void setOnlineEditorUrl(String onlineEditorUrl)
URL to edit the file online- Parameters:
onlineEditorUrl
- URL to edit the file online
-
getPdfConversionStatus
public PdfConversionStatus getPdfConversionStatus()
The status of PDF conversion- Returns:
- The status of PDF conversion
-
setPdfConversionStatus
public void setPdfConversionStatus(PdfConversionStatus pdfConversionStatus)
The status of PDF conversion- Parameters:
pdfConversionStatus
- The status of PDF conversion
-
getRmsEnabled
public Boolean getRmsEnabled()
RMS enabled- Returns:
- RMS enabled
-
setRmsEnabled
public void setRmsEnabled(Boolean rmsEnabled)
RMS enabled- Parameters:
rmsEnabled
- RMS enabled
-
getConvertedName
public String getConvertedName()
Converted name for file- Returns:
- Converted name for file
-
setConvertedName
public void setConvertedName(String convertedName)
Converted name for file- Parameters:
convertedName
- Converted name for file
-
getLicenseHoursValid
public Integer getLicenseHoursValid()
Max hours that the license is valid- Returns:
- Max hours that the license is valid
-
setLicenseHoursValid
public void setLicenseHoursValid(Integer licenseHoursValid)
Max hours that the license is valid- Parameters:
licenseHoursValid
- Max hours that the license is valid
-
getModifiedBy
public String getModifiedBy()
Modified by- Returns:
- Modified by
-
setModifiedBy
public void setModifiedBy(String modifiedBy)
Modified by- Parameters:
modifiedBy
- Modified by
-
getDlpStatus
public String getDlpStatus()
return the DLP status of an uploading document- Returns:
- return the DLP status of an uploading document
-
setDlpStatus
public void setDlpStatus(String dlpStatus)
return the DLP status of an uploading document- Parameters:
dlpStatus
- return the DLP status of an uploading document
-
getTransientDocumentCommentCountJson
public TransientDocumentCommentCountJson getTransientDocumentCommentCountJson()
Comments count- Returns:
- Comments count
-
setTransientDocumentCommentCountJson
public void setTransientDocumentCommentCountJson(TransientDocumentCommentCountJson transientDocumentCommentCountJson)
Comments count- Parameters:
transientDocumentCommentCountJson
- Comments count
-
getSupportedFileType
public Boolean getSupportedFileType()
Indicates that a file can be shown in Watchdox Online Viewer- Returns:
- Indicates that a file can be shown in Watchdox Online Viewer
-
setSupportedFileType
public void setSupportedFileType(Boolean supportedFileType)
Indicates that a file can be shown in Watchdox Online Viewer- Parameters:
supportedFileType
- Indicates that a file can be shown in Watchdox Online Viewer
-
getOpenToAnyone
public Boolean getOpenToAnyone()
Indicates that the file can be accessed by non-authenticated users- Returns:
- Indicates that the file can be accessed by non-authenticated users
-
setOpenToAnyone
public void setOpenToAnyone(Boolean openToAnyone)
Indicates that the file can be accessed by non-authenticated users- Parameters:
openToAnyone
- Indicates that the file can be accessed by non-authenticated users
-
getAccessLevel
public DocumentAccessLevel getAccessLevel()
Document Access Level. Levels are FULL, VIEWER, TRACKING, NONE.- Returns:
- Document Access Level. Levels are FULL, VIEWER, TRACKING, NONE.
-
setAccessLevel
public void setAccessLevel(DocumentAccessLevel accessLevel)
Document Access Level. Levels are FULL, VIEWER, TRACKING, NONE.- Parameters:
accessLevel
- Document Access Level. Levels are FULL, VIEWER, TRACKING, NONE.
-
getEditorUrl
public String getEditorUrl()
URL to edit the document using Wopi- Returns:
- URL to edit the document using Wopi
-
setEditorUrl
public void setEditorUrl(String editorUrl)
URL to edit the document using Wopi- Parameters:
editorUrl
- URL to edit the document using Wopi
-
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.
-
getViewerUrl
public String getViewerUrl()
URL of a (protected) file for viewing .- Returns:
- URL of a (protected) file for viewing .
-
setViewerUrl
public void setViewerUrl(String viewerUrl)
URL of a (protected) file for viewing .- Parameters:
viewerUrl
- URL of a (protected) file for viewing .
-
getFolderUuid
public String getFolderUuid()
Folder uuid- Returns:
- Folder uuid
-
setFolderUuid
public void setFolderUuid(String folderUuid)
Folder uuid- Parameters:
folderUuid
- Folder uuid
-
getNumOfVersions
public Integer getNumOfVersions()
Indicates how many versions this file has- Returns:
- Indicates how many versions this file has
-
setNumOfVersions
public void setNumOfVersions(Integer numOfVersions)
Indicates how many versions this file has- Parameters:
numOfVersions
- Indicates how many versions this file has
-
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.
-
getWorkspaceUuid
public String getWorkspaceUuid()
Workspace uuid- Returns:
- Workspace uuid
-
setWorkspaceUuid
public void setWorkspaceUuid(String workspaceUuid)
Workspace uuid- Parameters:
workspaceUuid
- Workspace uuid
-
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.
-
getTagList
public TagListJson getTagList()
Tags, if exist.- Returns:
- Tags, if exist.
-
setTagList
public void setTagList(TagListJson tagList)
Tags, if exist.- Parameters:
tagList
- Tags, if exist.
-
getStarredDate
public Date getStarredDate()
Mark date- Returns:
- Mark date
-
setStarredDate
public void setStarredDate(Date starredDate)
Mark date- Parameters:
starredDate
- Mark date
-
getAnnotationsList
public DocumentAnnotationsListJson getAnnotationsList()
A json which represents the users who annotated the file, and the last update date of their annotation- Returns:
- A json which represents the users who annotated the file, and the last update date of their annotation
-
setAnnotationsList
public void setAnnotationsList(DocumentAnnotationsListJson annotationsList)
A json which represents the users who annotated the file, and the last update date of their annotation- Parameters:
annotationsList
- A json which represents the users who annotated the file, and the last update date of their annotation
-
getInheritsPerms
public Boolean getInheritsPerms()
Inherits permissions- Returns:
- Inherits permissions
-
setInheritsPerms
public void setInheritsPerms(Boolean inheritsPerms)
Inherits permissions- Parameters:
inheritsPerms
- Inherits permissions
-
getFolderDisplay
public String getFolderDisplay()
The display value of folder. Most time it is same same folder, exception for Box Repository, the front ownerId is removed. Example: "/8221421110/chapter6/FolderTest2222" -> "/chapter6/FolderTest2222"- Returns:
- The display value of folder. Most time it is same same folder, exception for Box Repository, the front ownerId is removed. Example: "/8221421110/chapter6/FolderTest2222" -> "/chapter6/FolderTest2222"
-
setFolderDisplay
public void setFolderDisplay(String folderDisplay)
The display value of folder. Most time it is same same folder, exception for Box Repository, the front ownerId is removed. Example: "/8221421110/chapter6/FolderTest2222" -> "/chapter6/FolderTest2222"- Parameters:
folderDisplay
- The display value of folder. Most time it is same same folder, exception for Box Repository, the front ownerId is removed. Example: "/8221421110/chapter6/FolderTest2222" -> "/chapter6/FolderTest2222"
-
-