Class ChangeEntityVdrJson

java.lang.Object
com.blackberry.workspaces.sdk.api.json.BaseJson
com.blackberry.workspaces.sdk.api.json.ChangeEntityVdrJson
All Implemented Interfaces:
Serializable

public class ChangeEntityVdrJson
extends BaseJson
Change a single workspace member permissions for a workspace.
See Also:
Serialized Form
  • Constructor Details

  • Method Details

    • getPermittedEntity

      public PermittedEntityFromUserJson getPermittedEntity()
      The entities to modify.
      Returns:
      The entities to modify.
    • setPermittedEntity

      public void setPermittedEntity​(PermittedEntityFromUserJson permittedEntity)
      The entities to modify.
      Parameters:
      permittedEntity - The entities to modify.
    • getIdentifier

      public String getIdentifier()
      Only for workspace groups - adds another identifier to find the group by. This identifier may be supplied instead of workspace group name or address, in all workspace group based operations.
      Returns:
      Only for workspace groups - adds another identifier to find the group by. This identifier may be supplied instead of workspace group name or address, in all workspace group based operations.
    • setIdentifier

      public void setIdentifier​(String identifier)
      Only for workspace groups - adds another identifier to find the group by. This identifier may be supplied instead of workspace group name or address, in all workspace group based operations.
      Parameters:
      identifier - Only for workspace groups - adds another identifier to find the group by. This identifier may be supplied instead of workspace group name or address, in all workspace group based operations.
    • getRole

      public String getRole()
      The new role in the workspace.
      Returns:
      The new role in the workspace.
    • setRole

      public void setRole​(String role)
      The new role in the workspace.
      Parameters:
      role - The new role in the workspace.
    • isAddEntityToAllDocs

      public boolean isAddEntityToAllDocs()
      If left empty will be treated as false.
      Returns:
      If left empty will be treated as false.
    • setAddEntityToAllDocs

      public void setAddEntityToAllDocs​(boolean addEntityToAllDocs)
      If left empty will be treated as false.
      Parameters:
      addEntityToAllDocs - If left empty will be treated as false.
    • getFolderPathOrId

      public PathOrFolderIdJson getFolderPathOrId()
    • setFolderPathOrId

      public void setFolderPathOrId​(PathOrFolderIdJson folderPathOrId)
    • getNewGroupName

      public String getNewGroupName()
      Only for workspace groups - change the workspace group name to the name given here.
      Returns:
      Only for workspace groups - change the workspace group name to the name given here.
    • setNewGroupName

      public void setNewGroupName​(String newGroupName)
      Only for workspace groups - change the workspace group name to the name given here.
      Parameters:
      newGroupName - Only for workspace groups - change the workspace group name to the name given here.
    • isIsDefaultEntity

      public boolean isIsDefaultEntity()
      Set if the entity is default for workspace
      Returns:
      Set if the entity is default for workspace
    • getIsDefaultEntity

      @Deprecated public boolean getIsDefaultEntity()
      Deprecated.
      Set if the entity is default for workspace
      Returns:
      Set if the entity is default for workspace
    • setIsDefaultEntity

      public void setIsDefaultEntity​(boolean isDefaultEntity)
      Set if the entity is default for workspace
      Parameters:
      isDefaultEntity - Set if the entity is default for workspace
    • getDescription

      public String getDescription()
      Set description (only for groups)
      Returns:
      Set description (only for groups)
    • setDescription

      public void setDescription​(String description)
      Set description (only for groups)
      Parameters:
      description - Set description (only for groups)
    • getNewPermissions

      public PermissionFromUserJson getNewPermissions()
      Workspace permissions
      Returns:
      Workspace permissions
    • setNewPermissions

      public void setNewPermissions​(PermissionFromUserJson newPermissions)
      Workspace permissions
      Parameters:
      newPermissions - Workspace permissions
    • isApplyToExistingDocs

      public boolean isApplyToExistingDocs()
      Apply these permissions to the files this entity is already authorized for.
      Returns:
      Apply these permissions to the files this entity is already authorized for.
    • setApplyToExistingDocs

      public void setApplyToExistingDocs​(boolean applyToExistingDocs)
      Apply these permissions to the files this entity is already authorized for.
      Parameters:
      applyToExistingDocs - Apply these permissions to the files this entity is already authorized for.