Class AddFolderEntityJson
- java.lang.Object
-
- com.blackberry.workspaces.api.sdk.json.BaseJson
-
- com.blackberry.workspaces.api.sdk.json.AddFolderEntityJson
-
- All Implemented Interfaces:
Serializable
public class AddFolderEntityJson extends BaseJson
List information when adding a user to a workspace.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description AddFolderEntityJson()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description String
getDescription()
Set description (only for groups) relevant only if permittedEntity is a roomGroupString
getEmailMessage()
String
getEmailSubject()
PathOrFolderIdJson
getFolderPathOrId()
Path or id for the folder to be changed, if not supplied the root folder will be assumedAddMembersToGroupJson
getGroupMembers()
In case of a workspace group was supplied in field "permittedEntity" 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
getIncludeAllSubItems()
boolean
getIsDefaultEntity()
Deprecated.PermissionFromUserJson
getNewPermissions()
Workspace permissionsPermittedEntityFromUserJson
getPermittedEntity()
Single entity to add.String
getRole()
The new role in the workspace.Set<PermittedEntityFromUserJson>
getRoomEntities()
List<GroupAndMembersJson>
getRoomGroups()
String
getRoomGuid()
Guid of the workspaceInteger
getRoomId()
Id of the workspaceboolean
isIsDefaultEntity()
Set if the entity is default for workspaceboolean
isIsSendMail()
void
setDescription(String description)
Set description (only for groups) relevant only if permittedEntity is a roomGroupvoid
setEmailMessage(String emailMessage)
void
setEmailSubject(String emailSubject)
void
setFolderPathOrId(PathOrFolderIdJson folderPathOrId)
Path or id for the folder to be changed, if not supplied the root folder will be assumedvoid
setGroupMembers(AddMembersToGroupJson groupMembers)
In case of a workspace group was supplied in field "permittedEntity" 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
setIncludeAllSubItems(Boolean includeAllSubItems)
void
setIsDefaultEntity(boolean isDefaultEntity)
Set if the entity is default for workspacevoid
setIsSendMail(boolean isSendMail)
void
setNewPermissions(PermissionFromUserJson newPermissions)
Workspace permissionsvoid
setPermittedEntity(PermittedEntityFromUserJson permittedEntity)
Single entity to add.void
setRole(String role)
The new role in the workspace.void
setRoomEntities(Set<PermittedEntityFromUserJson> roomEntities)
void
setRoomGroups(List<GroupAndMembersJson> roomGroups)
void
setRoomGuid(String roomGuid)
Guid of the workspacevoid
setRoomId(Integer roomId)
Id of the workspace-
Methods inherited from class com.blackberry.workspaces.api.sdk.json.BaseJson
getObjType, setObjType, toString
-
-
-
-
Method Detail
-
getGroupMembers
public AddMembersToGroupJson getGroupMembers()
In case of a workspace group was supplied in field "permittedEntity" these members will be added to the group, otherwise this will be ignored.- Returns:
- In case of a workspace group was supplied in field "permittedEntity" 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 was supplied in field "permittedEntity" these members will be added to the group, otherwise this will be ignored.- Parameters:
groupMembers
- In case of a workspace group was supplied in field "permittedEntity" these members will be added to the group, otherwise this will be ignored.
-
getPermittedEntity
public PermittedEntityFromUserJson getPermittedEntity()
Single entity to add.- Returns:
- Single entity to add.
-
setPermittedEntity
public void setPermittedEntity(PermittedEntityFromUserJson permittedEntity)
Single entity to add.- Parameters:
permittedEntity
- Single entity to add.
-
getRoomGuid
public String getRoomGuid()
Guid of the workspace- Returns:
- Guid of the workspace
-
setRoomGuid
public void setRoomGuid(String roomGuid)
Guid of the workspace- Parameters:
roomGuid
- Guid of the workspace
-
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. relvant only if permittedEntity is a roomGroup- 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. relvant only if permittedEntity is a roomGroup
-
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. relvant only if permittedEntity is a roomGroup- 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. relvant only if permittedEntity is a roomGroup
-
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.
-
getRoomGroups
public List<GroupAndMembersJson> getRoomGroups()
-
setRoomGroups
public void setRoomGroups(List<GroupAndMembersJson> roomGroups)
-
getFolderPathOrId
public PathOrFolderIdJson getFolderPathOrId()
Path or id for the folder to be changed, if not supplied the root folder will be assumed- Returns:
- Path or id for the folder to be changed, if not supplied the root folder will be assumed
-
setFolderPathOrId
public void setFolderPathOrId(PathOrFolderIdJson folderPathOrId)
Path or id for the folder to be changed, if not supplied the root folder will be assumed- Parameters:
folderPathOrId
- Path or id for the folder to be changed, if not supplied the root folder will be assumed
-
isIsSendMail
public boolean isIsSendMail()
-
setIsSendMail
public void setIsSendMail(boolean isSendMail)
-
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) relevant only if permittedEntity is a roomGroup- Returns:
- Set description (only for groups) relevant only if permittedEntity is a roomGroup
-
setDescription
public void setDescription(String description)
Set description (only for groups) relevant only if permittedEntity is a roomGroup- Parameters:
description
- Set description (only for groups) relevant only if permittedEntity is a roomGroup
-
getNewPermissions
public PermissionFromUserJson getNewPermissions()
Workspace permissions- Returns:
- Workspace permissions
-
setNewPermissions
public void setNewPermissions(PermissionFromUserJson newPermissions)
Workspace permissions- Parameters:
newPermissions
- Workspace permissions
-
getEmailSubject
public String getEmailSubject()
-
setEmailSubject
public void setEmailSubject(String emailSubject)
-
getRoomId
public Integer getRoomId()
Id of the workspace- Returns:
- Id of the workspace
-
setRoomId
public void setRoomId(Integer roomId)
Id of the workspace- Parameters:
roomId
- Id of the workspace
-
getIncludeAllSubItems
public Boolean getIncludeAllSubItems()
-
setIncludeAllSubItems
public void setIncludeAllSubItems(Boolean includeAllSubItems)
-
getRoomEntities
public Set<PermittedEntityFromUserJson> getRoomEntities()
-
setRoomEntities
public void setRoomEntities(Set<PermittedEntityFromUserJson> roomEntities)
-
getEmailMessage
public String getEmailMessage()
-
setEmailMessage
public void setEmailMessage(String emailMessage)
-
-