Class SubmitDocumentResultJson
- java.lang.Object
-
- com.blackberry.workspaces.sdk.api.json.BaseJson
-
- com.blackberry.workspaces.sdk.api.json.SubmitDocumentResultJson
-
- All Implemented Interfaces:
Serializable
public class SubmitDocumentResultJson extends BaseJson
Result from submitting a file- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description SubmitDocumentResultJson()
-
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 annotationString
getClassification()
Classification, if exists.String
getContentType()
String
getConvertedName()
Converted name for fileDate
getCreationDate()
Date of creation.DocumentCurrentVersionJson
getDocumentCurrentVersion()
A json which represents the current version of the fileString
getDocumentName()
Use 'name' insteadlong
getDownloadPdfSize()
long
getDownloadSize()
String
getEditorUrl()
URL of a (protected) file for editing .ExistingDocumentJson
getExistingDocument()
Date
getExpires()
Use permissions insteadDocumentExternalRepositoryDataJson
getExternalRepositoryData()
String
getFilename()
File name.String
getFolder()
File's folder, for example: /office/docsInteger
getFolderId()
Folder idString
getFolderUuid()
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' insteadDate
getModifiedDate()
Date of modified.String
getName()
File nameString
getOnlineEditorUrl()
URL to edit the document onlineBoolean
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
getReadConfirmation()
Date
getRecentlyViewed()
Date file was most recently viewed.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).StatusJson
getStatus()
Status, status number and error string in case of error.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
getWorkspaceUuid()
uuid of the workspace the file has been submitted to.void
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
setClassification(String classification)
Classification, if exists.void
setContentType(String contentType)
void
setConvertedName(String convertedName)
Converted name for filevoid
setCreationDate(Date creationDate)
Date of creation.void
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 of a (protected) file for editing .void
setExistingDocument(ExistingDocumentJson existingDocument)
void
setExpires(Date expires)
Use permissions insteadvoid
setExternalRepositoryData(DocumentExternalRepositoryDataJson externalRepositoryData)
void
setFilename(String filename)
File name.void
setFolder(String folder)
File's folder, for example: /office/docsvoid
setFolderId(Integer folderId)
Folder idvoid
setFolderUuid(String folderUuid)
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
setModifiedDate(Date modifiedDate)
Date of modified.void
setName(String name)
File namevoid
setOnlineEditorUrl(String onlineEditorUrl)
URL to edit the document onlinevoid
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
setReadConfirmation(Boolean readConfirmation)
void
setRecentlyViewed(Date recentlyViewed)
Date file was most recently viewed.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
setStatus(StatusJson status)
Status, status number and error string in case of error.void
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
setWorkspaceUuid(String workspaceUuid)
uuid of the workspace the file has been submitted to.-
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()
Use permissions instead- Returns:
- Use permissions instead
-
setExpires
public void setExpires(Date expires)
Use permissions instead- Parameters:
expires
- Use permissions instead
-
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
-
getDownloadPdfSize
public long getDownloadPdfSize()
-
setDownloadPdfSize
public void setDownloadPdfSize(long downloadPdfSize)
-
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
-
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
-
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
-
getOriginalReadAckState
public Boolean getOriginalReadAckState()
-
setOriginalReadAckState
public void setOriginalReadAckState(Boolean originalReadAckState)
-
getReadConfirmation
public Boolean getReadConfirmation()
-
setReadConfirmation
public void setReadConfirmation(Boolean readConfirmation)
-
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
-
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
-
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
-
getExistingDocument
public ExistingDocumentJson getExistingDocument()
-
setExistingDocument
public void setExistingDocument(ExistingDocumentJson existingDocument)
-
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).
-
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
-
getExternalRepositoryData
public DocumentExternalRepositoryDataJson getExternalRepositoryData()
-
setExternalRepositoryData
public void setExternalRepositoryData(DocumentExternalRepositoryDataJson externalRepositoryData)
-
getId
public Integer getId()
Id- Returns:
- Id
-
setId
public void setId(Integer id)
Id- Parameters:
id
- Id
-
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()
-
setContentType
public void setContentType(String contentType)
-
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.
-
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 of a (protected) file for editing .- Returns:
- URL of a (protected) file for editing .
-
setEditorUrl
public void setEditorUrl(String editorUrl)
URL of a (protected) file for editing .- Parameters:
editorUrl
- URL of a (protected) file for editing .
-
getSecureTransferFile
public Boolean getSecureTransferFile()
-
setSecureTransferFile
public void setSecureTransferFile(Boolean secureTransferFile)
-
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
-
getFolderUuid
public String getFolderUuid()
Folder uuid- Returns:
- Folder uuid
-
setFolderUuid
public void setFolderUuid(String folderUuid)
Folder uuid- Parameters:
folderUuid
- Folder uuid
-
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.
-
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 .
-
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.
-
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.
-
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.
-
getFolderId
public Integer getFolderId()
Folder id- Returns:
- Folder id
-
setFolderId
public void setFolderId(Integer folderId)
Folder id- Parameters:
folderId
- Folder id
-
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()
uuid of the workspace the file has been submitted to.- Returns:
- uuid of the workspace the file has been submitted to.
-
setWorkspaceUuid
public void setWorkspaceUuid(String workspaceUuid)
uuid of the workspace the file has been submitted to.- Parameters:
workspaceUuid
- uuid of the workspace the file has been submitted to.
-
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
-
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.
-
getFilename
public String getFilename()
File name.- Returns:
- File name.
-
setFilename
public void setFilename(String filename)
File name.- Parameters:
filename
- File name.
-
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)
-
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
-
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.
-
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.
-
-