Class SubmitTransientDocumentResultJson
java.lang.Object
com.blackberry.workspaces.sdk.api.json.BaseJson
com.blackberry.workspaces.sdk.api.json.SubmitTransientDocumentResultJson
- All Implemented Interfaces:
Serializable
public class SubmitTransientDocumentResultJson extends BaseJson
- See Also:
- Serialized Form
-
Constructor Summary
Constructors Constructor Description SubmitTransientDocumentResultJson()
-
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()
ExistingDocumentJson
getExistingDocument()
Date
getExpires()
Use permissions insteadDocumentExternalRepositoryDataJson
getExternalRepositoryData()
String
getFilename()
File name.String
getFolder()
File's folder, for example: /office/docsInteger
getFolderId()
String
getGuid()
Signed GUID of a file, created by the server.Integer
getId()
Date
getLastUpdated()
Date of creation or last update of the document.Date
getLastUpdateDate()
Use 'lastUpdated' insteadDate
getModifiedDate()
Date of modified.String
getName()
File nameLong
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.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 .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
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)
void
setGuid(String guid)
Signed GUID of a file, created by the server.void
setId(Integer id)
void
setLastUpdated(Date lastUpdated)
Date of creation or last update of the document.void
setLastUpdateDate(Date lastUpdateDate)
Use 'lastUpdated' insteadvoid
setModifiedDate(Date modifiedDate)
Date of modified.void
setName(String name)
File namevoid
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
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 .Methods inherited from class com.blackberry.workspaces.sdk.api.json.BaseJson
getObjType, setObjType, toString
-
Constructor Details
-
SubmitTransientDocumentResultJson
public SubmitTransientDocumentResultJson()
-
-
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
-
getLastUpdateDate
Use 'lastUpdated' instead- Returns:
- Use 'lastUpdated' instead
-
setLastUpdateDate
Use 'lastUpdated' instead- Parameters:
lastUpdateDate
- Use 'lastUpdated' instead
-
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
-
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
-
getLastUpdated
Date of creation or last update of the document.- Returns:
- Date of creation or last update of the document.
-
setLastUpdated
Date of creation or last update of the document.- Parameters:
lastUpdated
- Date of creation or last update of the document.
-
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
-
getExistingDocument
-
setExistingDocument
-
getConvertedName
Converted name for file- Returns:
- Converted name for file
-
setConvertedName
Converted name for file- Parameters:
convertedName
- Converted name for file
-
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).
-
getExternalRepositoryData
-
setExternalRepositoryData
-
getId
-
setId
-
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.
-
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 .
-
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.
-
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.
-
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
-
setFolderId
-
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.
-
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.
-
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
-
getTagList
Tags, if exist.- Returns:
- Tags, if exist.
-
setTagList
Tags, if exist.- Parameters:
tagList
- Tags, if exist.
-
getDownloadSize
public long getDownloadSize() -
setDownloadSize
public void setDownloadSize(long downloadSize) -
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
-
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
-
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.
-
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.
-