Class TransientDocumentJson
java.lang.Object
com.blackberry.workspaces.sdk.api.json.BaseJson
com.blackberry.workspaces.sdk.api.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
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 uuidMethods inherited from class com.blackberry.workspaces.sdk.api.json.BaseJson
getObjType, setObjType, toString
-
Constructor Details
-
TransientDocumentJson
public TransientDocumentJson()
-
-
Method Details
-
getPreviewUrl
URL to preview the file- Returns:
- URL to preview the file
-
setPreviewUrl
URL to preview the file- Parameters:
previewUrl
- URL to preview the file
-
getPendingRequests
Number of pending requests to access the file- Returns:
- Number of pending requests to access the file
-
setPendingRequests
Number of pending requests to access the file- Parameters:
pendingRequests
- Number of pending requests to access the file
-
getLastUpdateDate
Use 'lastUpdated' instead- Returns:
- Use 'lastUpdated' instead
-
setLastUpdateDate
Use 'lastUpdated' instead- Parameters:
lastUpdateDate
- Use 'lastUpdated' instead
-
getFileHash
File hash- Returns:
- File hash
-
setFileHash
File hash- Parameters:
fileHash
- File hash
-
getType
Use 'contentType' instead- Returns:
- Use 'contentType' instead
-
setType
Use 'contentType' instead- Parameters:
type
- Use 'contentType' instead
-
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.
-
getPath
Path of the file in the transient external repository- Returns:
- Path of the file in the transient external repository
-
setPath
Path of the file in the transient external repository- Parameters:
path
- Path of the file in the transient external repository
-
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
-
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
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
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
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
-
setExternalRepositoryData
-
getOriginalSize
Original size of file (bytes)- Returns:
- Original size of file (bytes)
-
setOriginalSize
Original size of file (bytes)- Parameters:
originalSize
- Original size of file (bytes)
-
getContentType
Content type- Returns:
- Content type
-
setContentType
Content type- Parameters:
contentType
- Content type
-
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
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.
-
getCacheStatus
Cache status- Returns:
- Cache status
-
setCacheStatus
Cache status- Parameters:
cacheStatus
- Cache status
-
getSecureTransferFile
Secure transfer file- Returns:
- Secure transfer file
-
setSecureTransferFile
Secure transfer file- Parameters:
secureTransferFile
- Secure transfer file
-
getClassification
Classification, if exists.- Returns:
- Classification, if exists.
-
setClassification
Classification, if exists.- Parameters:
classification
- Classification, if exists.
-
getCreationDate
Date of creation.- Returns:
- Date of creation.
-
setCreationDate
Date of creation.- Parameters:
creationDate
- Date of creation.
-
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
-
getFolderId
Folder id- Returns:
- Folder id
-
setFolderId
Folder id- Parameters:
folderId
- Folder id
-
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
-
setDownloadSize
-
getFilename
File name.- Returns:
- File name.
-
setFilename
File name.- Parameters:
filename
- File name.
-
getSender
Sender's email address- Returns:
- Sender's email address
-
setSender
Sender's email address- Parameters:
sender
- Sender's email address
-
getName
File name- Returns:
- File name
-
setName
File name- Parameters:
name
- File name
-
getModifiedDate
Date of modified.- Returns:
- Date of modified.
-
setModifiedDate
Date of modified.- Parameters:
modifiedDate
- Date of modified.
-
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.
-
getPercentCompleted
Progress status.- Returns:
- Progress status.
-
setPercentCompleted
Progress status.- Parameters:
percentCompleted
- Progress status.
-
getExpires
Use permissions instead- Returns:
- Use permissions instead
-
setExpires
Use permissions instead- Parameters:
expires
- Use permissions instead
-
getDownloadPdfSize
-
setDownloadPdfSize
-
getOnlineEditorUrl
URL to edit the file online- Returns:
- URL to edit the file online
-
setOnlineEditorUrl
URL to edit the file online- Parameters:
onlineEditorUrl
- URL to edit the file online
-
getPdfConversionStatus
The status of PDF conversion- Returns:
- The status of PDF conversion
-
setPdfConversionStatus
The status of PDF conversion- Parameters:
pdfConversionStatus
- The status of PDF conversion
-
getRmsEnabled
RMS enabled- Returns:
- RMS enabled
-
setRmsEnabled
RMS enabled- Parameters:
rmsEnabled
- RMS enabled
-
getConvertedName
Converted name for file- Returns:
- Converted name for file
-
setConvertedName
Converted name for file- Parameters:
convertedName
- Converted name for file
-
getLicenseHoursValid
Max hours that the license is valid- Returns:
- Max hours that the license is valid
-
setLicenseHoursValid
Max hours that the license is valid- Parameters:
licenseHoursValid
- Max hours that the license is valid
-
getModifiedBy
Modified by- Returns:
- Modified by
-
setModifiedBy
Modified by- Parameters:
modifiedBy
- Modified by
-
getDlpStatus
return the DLP status of an uploading document- Returns:
- return the DLP status of an uploading document
-
setDlpStatus
return the DLP status of an uploading document- Parameters:
dlpStatus
- return the DLP status of an uploading document
-
getTransientDocumentCommentCountJson
Comments count- Returns:
- Comments count
-
setTransientDocumentCommentCountJson
public void setTransientDocumentCommentCountJson(TransientDocumentCommentCountJson transientDocumentCommentCountJson)Comments count- Parameters:
transientDocumentCommentCountJson
- Comments count
-
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
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
Indicates that the file can be accessed by non-authenticated users- Returns:
- Indicates that the file can be accessed by non-authenticated users
-
setOpenToAnyone
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
Document Access Level. Levels are FULL, VIEWER, TRACKING, NONE.- Returns:
- Document Access Level. Levels are FULL, VIEWER, TRACKING, NONE.
-
setAccessLevel
Document Access Level. Levels are FULL, VIEWER, TRACKING, NONE.- Parameters:
accessLevel
- Document Access Level. Levels are FULL, VIEWER, TRACKING, NONE.
-
getEditorUrl
URL to edit the document using Wopi- Returns:
- URL to edit the document using Wopi
-
setEditorUrl
URL to edit the document using Wopi- Parameters:
editorUrl
- URL to edit the document using Wopi
-
getDocumentName
Use 'name' instead- Returns:
- Use 'name' instead
-
setDocumentName
Use 'name' instead- Parameters:
documentName
- Use 'name' instead
-
getNumOfVersions
Indicates how many versions this file has- Returns:
- Indicates how many versions this file has
-
setNumOfVersions
Indicates how many versions this file has- Parameters:
numOfVersions
- Indicates how many versions this file has
-
getFolderUuid
Folder uuid- Returns:
- Folder uuid
-
setFolderUuid
Folder uuid- Parameters:
folderUuid
- 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.
-
getViewerUrl
URL of a (protected) file for viewing .- Returns:
- URL of a (protected) file for viewing .
-
setViewerUrl
URL of a (protected) file for viewing .- Parameters:
viewerUrl
- URL of a (protected) file for viewing .
-
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.
-
getWorkspaceUuid
Workspace uuid- Returns:
- Workspace uuid
-
setWorkspaceUuid
Workspace uuid- Parameters:
workspaceUuid
- Workspace uuid
-
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.
-
getTagList
Tags, if exist.- Returns:
- Tags, if exist.
-
setTagList
Tags, if exist.- Parameters:
tagList
- Tags, if exist.
-
getStarredDate
Mark date- Returns:
- Mark date
-
setStarredDate
Mark date- Parameters:
starredDate
- Mark date
-
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
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
Inherits permissions- Returns:
- Inherits permissions
-
setInheritsPerms
Inherits permissions- Parameters:
inheritsPerms
- Inherits permissions
-
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
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"
-