Class ValidateDownloadDocumentsSelectionVdrJson
java.lang.Object
com.blackberry.workspaces.sdk.api.json.BaseJson
com.blackberry.workspaces.sdk.api.json.ValidateDownloadDocumentsSelectionVdrJson
- All Implemented Interfaces:
Serializable
public class ValidateDownloadDocumentsSelectionVdrJson extends BaseJson
Used when validating files for download
- See Also:
- Serialized Form
-
Constructor Summary
Constructors Constructor Description ValidateDownloadDocumentsSelectionVdrJson()
-
Method Summary
Modifier and Type Method Description Set<String>
getDocumentGuids()
A list of file guids.DownloadTypes
getDownloadType()
Download type.Set<String>
getFolderGuids()
List of folder guidsSet<Integer>
getFolderIds()
List of folder idsSet<String>
getFolderPaths()
A list of folder pathsBoolean
getForceAction()
Force the action even if not allowed for all files provided (only allowed files will be affected).Boolean
getShouldAggregateMessage()
Should aggregate messgaeboolean
isShouldInitiatePdfConversion()
Not in use - newer versions will always initiate PDF conversion if requiredvoid
setDocumentGuids(Set<String> documentGuids)
A list of file guids.void
setDownloadType(DownloadTypes downloadType)
Download type.void
setFolderGuids(Set<String> folderGuids)
List of folder guidsvoid
setFolderIds(Set<Integer> folderIds)
List of folder idsvoid
setFolderPaths(Set<String> folderPaths)
A list of folder pathsvoid
setForceAction(Boolean forceAction)
Force the action even if not allowed for all files provided (only allowed files will be affected).void
setShouldAggregateMessage(Boolean shouldAggregateMessage)
Should aggregate messgaevoid
setShouldInitiatePdfConversion(boolean shouldInitiatePdfConversion)
Not in use - newer versions will always initiate PDF conversion if requiredMethods inherited from class com.blackberry.workspaces.sdk.api.json.BaseJson
getObjType, setObjType, toString
-
Constructor Details
-
ValidateDownloadDocumentsSelectionVdrJson
public ValidateDownloadDocumentsSelectionVdrJson()
-
-
Method Details
-
getDocumentGuids
A list of file guids.- Returns:
- A list of file guids.
-
setDocumentGuids
A list of file guids.- Parameters:
documentGuids
- A list of file guids.
-
getShouldAggregateMessage
Should aggregate messgae- Returns:
- Should aggregate messgae
-
setShouldAggregateMessage
Should aggregate messgae- Parameters:
shouldAggregateMessage
- Should aggregate messgae
-
getFolderGuids
List of folder guids- Returns:
- List of folder guids
-
setFolderGuids
List of folder guids- Parameters:
folderGuids
- List of folder guids
-
isShouldInitiatePdfConversion
public boolean isShouldInitiatePdfConversion()Not in use - newer versions will always initiate PDF conversion if required- Returns:
- Not in use - newer versions will always initiate PDF conversion if required
-
setShouldInitiatePdfConversion
public void setShouldInitiatePdfConversion(boolean shouldInitiatePdfConversion)Not in use - newer versions will always initiate PDF conversion if required- Parameters:
shouldInitiatePdfConversion
- Not in use - newer versions will always initiate PDF conversion if required
-
getDownloadType
Download type.- Returns:
- Download type.
-
setDownloadType
Download type.- Parameters:
downloadType
- Download type.
-
getFolderIds
List of folder ids- Returns:
- List of folder ids
-
setFolderIds
List of folder ids- Parameters:
folderIds
- List of folder ids
-
getFolderPaths
A list of folder paths- Returns:
- A list of folder paths
-
setFolderPaths
A list of folder paths- Parameters:
folderPaths
- A list of folder paths
-
getForceAction
Force the action even if not allowed for all files provided (only allowed files will be affected). Not all operations support this parameter.- Returns:
- Force the action even if not allowed for all files provided (only allowed files will be affected). Not all operations support this parameter.
-
setForceAction
Force the action even if not allowed for all files provided (only allowed files will be affected). Not all operations support this parameter.- Parameters:
forceAction
- Force the action even if not allowed for all files provided (only allowed files will be affected). Not all operations support this parameter.
-