Class AddEntityVdrJson
- java.lang.Object
-
- com.blackberry.workspaces.sdk.api.json.BaseJson
-
- com.blackberry.workspaces.sdk.api.json.AddEntityVdrJson
-
- All Implemented Interfaces:
Serializable
public class AddEntityVdrJson extends BaseJson
List information when adding a user to a workspace.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description AddEntityVdrJson()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description String
getDescription()
Set description (only for groups)AddMembersToGroupJson
getGroupMembers()
In case of a workspace group these members will be added to the group, otherwise this will be ignored.String
getIdentifier()
Only for workspace groups - adds another identifier to find the group by.boolean
getIsDefaultEntity()
Deprecated.PermissionFromUserJson
getNewPermissions()
Workspace permissionsPermittedEntityFromUserJson
getPermittedEntity()
The entity to addString
getRole()
The new role in the workspace.boolean
isAddEntityToAllDocs()
If left empty will be treated as false.boolean
isIsDefaultEntity()
Set if the entity is default for workspacevoid
setAddEntityToAllDocs(boolean addEntityToAllDocs)
If left empty will be treated as false.void
setDescription(String description)
Set description (only for groups)void
setGroupMembers(AddMembersToGroupJson groupMembers)
In case of a workspace group these members will be added to the group, otherwise this will be ignored.void
setIdentifier(String identifier)
Only for workspace groups - adds another identifier to find the group by.void
setIsDefaultEntity(boolean isDefaultEntity)
Set if the entity is default for workspacevoid
setNewPermissions(PermissionFromUserJson newPermissions)
Workspace permissionsvoid
setPermittedEntity(PermittedEntityFromUserJson permittedEntity)
The entity to addvoid
setRole(String role)
The new role in the workspace.-
Methods inherited from class com.blackberry.workspaces.sdk.api.json.BaseJson
getObjType, setObjType, toString
-
-
-
-
Method Detail
-
getGroupMembers
public AddMembersToGroupJson getGroupMembers()
In case of a workspace group these members will be added to the group, otherwise this will be ignored.- Returns:
- In case of a workspace group these members will be added to the group, otherwise this will be ignored.
-
setGroupMembers
public void setGroupMembers(AddMembersToGroupJson groupMembers)
In case of a workspace group these members will be added to the group, otherwise this will be ignored.- Parameters:
groupMembers
- In case of a workspace group these members will be added to the group, otherwise this will be ignored.
-
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.
-
getPermittedEntity
public PermittedEntityFromUserJson getPermittedEntity()
The entity to add- Returns:
- The entity to add
-
setPermittedEntity
public void setPermittedEntity(PermittedEntityFromUserJson permittedEntity)
The entity to add- Parameters:
permittedEntity
- The entity to add
-
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.
-
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
-
-