Class ChangeEntitiesVdrJson
java.lang.Object
com.blackberry.workspaces.sdk.api.json.BaseJson
com.blackberry.workspaces.sdk.api.json.ChangeEntitiesVdrJson
- All Implemented Interfaces:
Serializable
public class ChangeEntitiesVdrJson extends BaseJson
Change multiple workspace member permissions for a workspace.
- See Also:
- Serialized Form
-
Constructor Summary
Constructors Constructor Description ChangeEntitiesVdrJson()
-
Method Summary
Modifier and Type Method Description PathOrFolderIdJson
getFolderPathOrId()
Id or path of a single folder to modifySet<PathOrFolderIdJson>
getFolderPathsOrIds()
Id or paths of multiple folders to modifyBoolean
getForceAction()
Whether to do the action on the entities that haven't failed (true) Or through error on first error found (false)Boolean
getForceInheritanceOnDescendants()
if set to TRUE, all subfolders and files of the input folders will inherit permissions and get their parents' permissions (including the change made by this operation)Set<PermittedEntityWithPermissionsFromUserJson>
getPermittedEntitiesWithPermissions()
The entities with their new permissions.String
getRoomGuid()
Guid of the workspace where the folder existsInteger
getRoomId()
Id of the workspace where the folder existsvoid
setFolderPathOrId(PathOrFolderIdJson folderPathOrId)
Id or path of a single folder to modifyvoid
setFolderPathsOrIds(Set<PathOrFolderIdJson> folderPathsOrIds)
Id or paths of multiple folders to modifyvoid
setForceAction(Boolean forceAction)
Whether to do the action on the entities that haven't failed (true) Or through error on first error found (false)void
setForceInheritanceOnDescendants(Boolean forceInheritanceOnDescendants)
if set to TRUE, all subfolders and files of the input folders will inherit permissions and get their parents' permissions (including the change made by this operation)void
setPermittedEntitiesWithPermissions(Set<PermittedEntityWithPermissionsFromUserJson> permittedEntitiesWithPermissions)
The entities with their new permissions.void
setRoomGuid(String roomGuid)
Guid of the workspace where the folder existsvoid
setRoomId(Integer roomId)
Id of the workspace where the folder existsMethods inherited from class com.blackberry.workspaces.sdk.api.json.BaseJson
getObjType, setObjType, toString
-
Constructor Details
-
ChangeEntitiesVdrJson
public ChangeEntitiesVdrJson()
-
-
Method Details
-
getRoomGuid
Guid of the workspace where the folder exists- Returns:
- Guid of the workspace where the folder exists
-
setRoomGuid
Guid of the workspace where the folder exists- Parameters:
roomGuid
- Guid of the workspace where the folder exists
-
getFolderPathOrId
Id or path of a single folder to modify- Returns:
- Id or path of a single folder to modify
-
setFolderPathOrId
Id or path of a single folder to modify- Parameters:
folderPathOrId
- Id or path of a single folder to modify
-
getPermittedEntitiesWithPermissions
The entities with their new permissions.- Returns:
- The entities with their new permissions.
-
setPermittedEntitiesWithPermissions
public void setPermittedEntitiesWithPermissions(Set<PermittedEntityWithPermissionsFromUserJson> permittedEntitiesWithPermissions)The entities with their new permissions.- Parameters:
permittedEntitiesWithPermissions
- The entities with their new permissions.
-
getFolderPathsOrIds
Id or paths of multiple folders to modify- Returns:
- Id or paths of multiple folders to modify
-
setFolderPathsOrIds
Id or paths of multiple folders to modify- Parameters:
folderPathsOrIds
- Id or paths of multiple folders to modify
-
getForceInheritanceOnDescendants
if set to TRUE, all subfolders and files of the input folders will inherit permissions and get their parents' permissions (including the change made by this operation)- Returns:
- if set to TRUE, all subfolders and files of the input folders will inherit permissions and get their parents' permissions (including the change made by this operation)
-
setForceInheritanceOnDescendants
if set to TRUE, all subfolders and files of the input folders will inherit permissions and get their parents' permissions (including the change made by this operation)- Parameters:
forceInheritanceOnDescendants
- if set to TRUE, all subfolders and files of the input folders will inherit permissions and get their parents' permissions (including the change made by this operation)
-
getRoomId
Id of the workspace where the folder exists- Returns:
- Id of the workspace where the folder exists
-
setRoomId
Id of the workspace where the folder exists- Parameters:
roomId
- Id of the workspace where the folder exists
-
getForceAction
Whether to do the action on the entities that haven't failed (true) Or through error on first error found (false)- Returns:
- Whether to do the action on the entities that haven't failed (true) Or through error on first error found (false)
-
setForceAction
Whether to do the action on the entities that haven't failed (true) Or through error on first error found (false)- Parameters:
forceAction
- Whether to do the action on the entities that haven't failed (true) Or through error on first error found (false)
-