Class DocumentJson
- java.lang.Object
-
- com.blackberry.workspaces.api.sdk.json.BaseJson
-
- com.blackberry.workspaces.api.sdk.json.DocumentJson
-
- All Implemented Interfaces:
Serializable
public class DocumentJson extends BaseJson
A file that is used in various operations- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description DocumentJson()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description DocumentAccessLevel
getAccessLevel()
Document Access Level.DocumentAnnotationsListJson
getAnnotationsList()
A json which represents the users who annotated the document, and the last update date of their annotationCacheDocumentStatus
getCacheStatus()
String
getClassification()
Classification, if exists.Boolean
getCollaboration()
String
getContentType()
Content typeString
getConvertedName()
Converted name for fileDate
getCreationDate()
Date of creation.String
getDlpStatus()
return the DLP status of an uploading fileDocumentCommentCountJson
getDocumentCommentCountJson()
DocumentCurrentVersionJson
getDocumentCurrentVersion()
A json which represents the current version of the documentString
getDocumentName()
Use 'name' insteadlong
getDownloadPdfSize()
long
getDownloadSize()
String
getEditorUrl()
URL to edit the document using WopiDate
getExpires()
Use permissions insteadDocumentExternalRepositoryDataJson
getExternalRepositoryData()
String
getFileHash()
String
getFilename()
File name.String
getFolder()
File's folder, for example: /office/docsInteger
getFolderId()
String
getFolderUuid()
Boolean
getFoundInContent()
Boolean
getFoundInMetadata()
String
getGuid()
Signed GUID of a file, created by the server.Integer
getId()
Boolean
getInheritsPerms()
Date
getLastUpdated()
Date of creation or last update of the file.Date
getLastUpdateDate()
Use 'lastUpdated' insteadString
getLastVersionUploaderUserAddress()
Integer
getLicenseHoursValid()
Max hours that the license is validString
getLockingUserAddress()
Date
getModifiedDate()
Date of modified.String
getName()
File nameInteger
getNumOfVersions()
Indicates how many versions this file hasString
getOnlineEditorUrl()
URL to edit the document onlineboolean
getOpenToAnyone()
Deprecated.Boolean
getOriginalReadAckState()
Long
getOriginalSize()
Original size of file (bytes)PdfConversionStatus
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.Boolean
getReadAcknowledged()
Boolean
getReadConfirmation()
ReadyForDownloadOriginal
getReadyForDownloadOriginal()
Date
getRecentlyViewed()
Date file was most recently viewed.Boolean
getRmsEnabled()
String
getRoom()
Id of the workspace the file has been submitted to.Float
getScore()
The score of the file in the current searchBoolean
getSecureTransferFile()
String
getSender()
Sender's email addressBoolean
getStarred()
Will be true if the file was marked as starred (favorite).Date
getStarredDate()
StatusJson
getStatus()
Status, status number and error string in case of error.boolean
getSupportedFileType()
Deprecated.TagListJson
getTagList()
Tags, if exist.String
getType()
Use 'contentType' insteadString
getUrl()
URL of a (protected) file.String
getViewerUrl()
URL of a (protected) file for viewing .String
getWorkspaceType()
String
getWorkspaceUuid()
Workspace uuidboolean
isOpenToAnyone()
Indicates that the file can be accessed by non-authenticated usersboolean
isSupportedFileType()
Indicates that a file can be shown in Watchdox Online Viewervoid
setAccessLevel(DocumentAccessLevel accessLevel)
Document Access Level.void
setAnnotationsList(DocumentAnnotationsListJson annotationsList)
A json which represents the users who annotated the document, and the last update date of their annotationvoid
setCacheStatus(CacheDocumentStatus cacheStatus)
void
setClassification(String classification)
Classification, if exists.void
setCollaboration(Boolean collaboration)
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 filevoid
setDocumentCommentCountJson(DocumentCommentCountJson documentCommentCountJson)
void
setDocumentCurrentVersion(DocumentCurrentVersionJson documentCurrentVersion)
A json which represents the current version of the documentvoid
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)
void
setFilename(String filename)
File name.void
setFolder(String folder)
File's folder, for example: /office/docsvoid
setFolderId(Integer folderId)
void
setFolderUuid(String folderUuid)
void
setFoundInContent(Boolean foundInContent)
void
setFoundInMetadata(Boolean foundInMetadata)
void
setGuid(String guid)
Signed GUID of a file, created by the server.void
setId(Integer id)
void
setInheritsPerms(Boolean inheritsPerms)
void
setLastUpdated(Date lastUpdated)
Date of creation or last update of the file.void
setLastUpdateDate(Date lastUpdateDate)
Use 'lastUpdated' insteadvoid
setLastVersionUploaderUserAddress(String lastVersionUploaderUserAddress)
void
setLicenseHoursValid(Integer licenseHoursValid)
Max hours that the license is validvoid
setLockingUserAddress(String lockingUserAddress)
void
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 document onlinevoid
setOpenToAnyone(boolean openToAnyone)
Indicates that the file can be accessed by non-authenticated usersvoid
setOriginalReadAckState(Boolean originalReadAckState)
void
setOriginalSize(Long originalSize)
Original size of file (bytes)void
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
setReadAcknowledged(Boolean readAcknowledged)
void
setReadConfirmation(Boolean readConfirmation)
void
setReadyForDownloadOriginal(ReadyForDownloadOriginal readyForDownloadOriginal)
void
setRecentlyViewed(Date recentlyViewed)
Date file was most recently viewed.void
setRmsEnabled(Boolean rmsEnabled)
void
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)
void
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)
void
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
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
setWorkspaceType(String workspaceType)
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()
-
setFileHash
public void setFileHash(String fileHash)
-
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
-
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
-
getFoundInMetadata
public Boolean getFoundInMetadata()
-
setFoundInMetadata
public void setFoundInMetadata(Boolean foundInMetadata)
-
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).
-
getExternalRepositoryData
public DocumentExternalRepositoryDataJson getExternalRepositoryData()
-
setExternalRepositoryData
public void setExternalRepositoryData(DocumentExternalRepositoryDataJson externalRepositoryData)
-
getReadyForDownloadOriginal
public ReadyForDownloadOriginal getReadyForDownloadOriginal()
-
setReadyForDownloadOriginal
public void setReadyForDownloadOriginal(ReadyForDownloadOriginal readyForDownloadOriginal)
-
getId
public Integer getId()
-
setId
public void setId(Integer id)
-
getDocumentCommentCountJson
public DocumentCommentCountJson getDocumentCommentCountJson()
-
setDocumentCommentCountJson
public void setDocumentCommentCountJson(DocumentCommentCountJson documentCommentCountJson)
-
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.
-
getCacheStatus
public CacheDocumentStatus getCacheStatus()
-
setCacheStatus
public void setCacheStatus(CacheDocumentStatus cacheStatus)
-
getSecureTransferFile
public Boolean getSecureTransferFile()
-
setSecureTransferFile
public void setSecureTransferFile(Boolean secureTransferFile)
-
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 document- Returns:
- A json which represents the current version of the document
-
setDocumentCurrentVersion
public void setDocumentCurrentVersion(DocumentCurrentVersionJson documentCurrentVersion)
A json which represents the current version of the document- Parameters:
documentCurrentVersion
- A json which represents the current version of the document
-
getFolderId
public Integer getFolderId()
-
setFolderId
public void setFolderId(Integer folderId)
-
getRecentlyViewed
public Date getRecentlyViewed()
Date file was most recently viewed. not supported any longer - info is meaningless- Returns:
- Date file was most recently viewed. not supported any longer - info is meaningless
-
setRecentlyViewed
public void setRecentlyViewed(Date recentlyViewed)
Date file was most recently viewed. not supported any longer - info is meaningless- Parameters:
recentlyViewed
- Date file was most recently viewed. not supported any longer - info is meaningless
-
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.
-
getDownloadSize
public long getDownloadSize()
-
setDownloadSize
public void setDownloadSize(long downloadSize)
-
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
-
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.
-
getName
public String getName()
File name- Returns:
- File name
-
setName
public void setName(String name)
File name- Parameters:
name
- File 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.
-
getFoundInContent
public Boolean getFoundInContent()
-
setFoundInContent
public void setFoundInContent(Boolean foundInContent)
-
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.
-
getLockingUserAddress
public String getLockingUserAddress()
-
setLockingUserAddress
public void setLockingUserAddress(String lockingUserAddress)
-
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 document online- Returns:
- URL to edit the document online
-
setOnlineEditorUrl
public void setOnlineEditorUrl(String onlineEditorUrl)
URL to edit the document online- Parameters:
onlineEditorUrl
- URL to edit the document online
-
getOriginalReadAckState
public Boolean getOriginalReadAckState()
-
setOriginalReadAckState
public void setOriginalReadAckState(Boolean originalReadAckState)
-
getReadConfirmation
public Boolean getReadConfirmation()
-
setReadConfirmation
public void setReadConfirmation(Boolean readConfirmation)
-
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()
-
setRmsEnabled
public void setRmsEnabled(Boolean rmsEnabled)
-
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
-
getDlpStatus
public String getDlpStatus()
return the DLP status of an uploading file- Returns:
- return the DLP status of an uploading file
-
setDlpStatus
public void setDlpStatus(String dlpStatus)
return the DLP status of an uploading file- Parameters:
dlpStatus
- return the DLP status of an uploading file
-
isSupportedFileType
public boolean isSupportedFileType()
Indicates that a file can be shown in Watchdox Online Viewer- Returns:
- Indicates that a file can be shown in Watchdox Online Viewer
-
getSupportedFileType
@Deprecated public boolean getSupportedFileType()
Deprecated.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
-
isOpenToAnyone
public boolean isOpenToAnyone()
Indicates that the file can be accessed by non-authenticated users- Returns:
- Indicates that the file can be accessed by non-authenticated users
-
getOpenToAnyone
@Deprecated public boolean getOpenToAnyone()
Deprecated.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
-
getReadAcknowledged
public Boolean getReadAcknowledged()
-
setReadAcknowledged
public void setReadAcknowledged(Boolean readAcknowledged)
-
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
-
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
-
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()
-
setFolderUuid
public void setFolderUuid(String folderUuid)
-
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 .
-
getWorkspaceUuid
public String getWorkspaceUuid()
Workspace uuid- Returns:
- Workspace uuid
-
setWorkspaceUuid
public void setWorkspaceUuid(String workspaceUuid)
Workspace uuid- Parameters:
workspaceUuid
- Workspace uuid
-
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.
-
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.
-
getWorkspaceType
public String getWorkspaceType()
-
setWorkspaceType
public void setWorkspaceType(String workspaceType)
-
getStarredDate
public Date getStarredDate()
-
setStarredDate
public void setStarredDate(Date starredDate)
-
getAnnotationsList
public DocumentAnnotationsListJson getAnnotationsList()
A json which represents the users who annotated the document, and the last update date of their annotation- Returns:
- A json which represents the users who annotated the document, and the last update date of their annotation
-
setAnnotationsList
public void setAnnotationsList(DocumentAnnotationsListJson annotationsList)
A json which represents the users who annotated the document, and the last update date of their annotation- Parameters:
annotationsList
- A json which represents the users who annotated the document, and the last update date of their annotation
-
getCollaboration
public Boolean getCollaboration()
-
setCollaboration
public void setCollaboration(Boolean collaboration)
-
getInheritsPerms
public Boolean getInheritsPerms()
-
setInheritsPerms
public void setInheritsPerms(Boolean inheritsPerms)
-
getLastVersionUploaderUserAddress
public String getLastVersionUploaderUserAddress()
-
setLastVersionUploaderUserAddress
public void setLastVersionUploaderUserAddress(String lastVersionUploaderUserAddress)
-
-