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
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
-
Constructor Details
-
SubmitDocumentResultJson
public SubmitDocumentResultJson()
-
-
Method Details
-
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
-
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
-
getDownloadPdfSize
public long getDownloadPdfSize() -
setDownloadPdfSize
public void setDownloadPdfSize(long downloadPdfSize) -
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
-
getOnlineEditorUrl
URL to edit the document online- Returns:
- URL to edit the document online
-
setOnlineEditorUrl
URL to edit the document online- Parameters:
onlineEditorUrl
- URL to edit the document online
-
getOriginalReadAckState
-
setOriginalReadAckState
-
getLastUpdateDate
Use 'lastUpdated' instead- Returns:
- Use 'lastUpdated' instead
-
setLastUpdateDate
Use 'lastUpdated' instead- Parameters:
lastUpdateDate
- Use 'lastUpdated' instead
-
getReadConfirmation
-
setReadConfirmation
-
getType
Use 'contentType' instead- Returns:
- Use 'contentType' instead
-
setType
Use 'contentType' instead- Parameters:
type
- Use 'contentType' instead
-
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
-
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.
-
getExistingDocument
-
setExistingDocument
-
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).
-
getConvertedName
Converted name for file- Returns:
- Converted name for file
-
setConvertedName
Converted name for file- Parameters:
convertedName
- Converted name for file
-
getExternalRepositoryData
-
setExternalRepositoryData
-
getId
Id- Returns:
- Id
-
setId
Id- Parameters:
id
- Id
-
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
-
setContentType
-
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.
-
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 of a (protected) file for editing .- Returns:
- URL of a (protected) file for editing .
-
setEditorUrl
URL of a (protected) file for editing .- Parameters:
editorUrl
- URL of a (protected) file for editing .
-
getSecureTransferFile
-
setSecureTransferFile
-
getDocumentName
Use 'name' instead- Returns:
- Use 'name' instead
-
setDocumentName
Use 'name' instead- Parameters:
documentName
- Use 'name' instead
-
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 .
-
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.
-
getClassification
Classification, if exists.- Returns:
- Classification, if exists.
-
setClassification
Classification, if exists.- Parameters:
classification
- Classification, if exists.
-
getFolderUuid
Folder uuid- Returns:
- Folder uuid
-
setFolderUuid
Folder uuid- Parameters:
folderUuid
- Folder uuid
-
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
-
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
uuid of the workspace the file has been submitted to.- Returns:
- uuid of the workspace the file has been submitted to.
-
setWorkspaceUuid
uuid of the workspace the file has been submitted to.- Parameters:
workspaceUuid
- uuid of the workspace the file has been submitted to.
-
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.
-
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
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
-
getFilename
File name.- Returns:
- File name.
-
setFilename
File name.- Parameters:
filename
- File name.
-
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
Sender's email address- Returns:
- Sender's email address
-
setSender
Sender's email address- Parameters:
sender
- Sender's email address
-
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
-
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.
-
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.
-