ForumsRoleMap (Appian API)

java.lang.Object
- com.appiancorp.suiteapi.common.RoleMap
- - com.appiancorp.suiteapi.common.PublicRoleMap
  - - com.appiancorp.suiteapi.forums.ForumsRoleMap

All Implemented Interfaces:

XMLable, java.io.Serializable, java.util.Map

Deprecated.
The Discussion Forums functionality will be removed in a future release. Use the News feed and related smart services to build applications with similar functionality.
```
@Deprecated
public class ForumsRoleMap
extends PublicRoleMap
```
See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ADMIN_INT_VALUE` Deprecated.
`static java.lang.String`	`PARTICIPANT` Deprecated.
`static int`	`PARTICIPANT_INT_VALUE` Deprecated.
`static java.lang.String`	`ROLE_ADMINISTRATOR` Deprecated.
`static java.lang.String`	`ROLE_ANONYMOUS` Deprecated.
`static java.lang.String`	`ROLE_APPADMIN` Deprecated.
`static java.lang.String`	`ROLE_EXPLICIT_NONMEMBER` Deprecated.
`static java.lang.String`	`ROLE_OWNER` Deprecated.
`static java.lang.String`	`ROLE_READER` Deprecated.
`static java.lang.String`	`ROLE_SYSADMIN` Deprecated.
`static java.lang.String`	`ROLE_USER` Deprecated.
`static java.lang.String`	`ROLE_WRITER` Deprecated.

Fields inherited from class com.appiancorp.suiteapi.common.PublicRoleMap
ADMINISTRATOR, TYPE_GROUP, TYPE_USER

Fields inherited from class com.appiancorp.suiteapi.common.RoleMap
AGGREGATE_SECURITY_KEY, SECURITY_KEY, TYPE_AGGREGATE_GROUP, TYPE_AGGREGATE_USER, TYPE_GROUP_UUIDS, TYPE_USER_UUIDS

Fields inherited from interface com.appiancorp.suiteapi.common.XMLable
DEFAULT_BUFFER_SIZE

Constructor Summary

Constructors
Constructor and Description

ForumsRoleMap()
Deprecated.

ForumsRoleMap(RoleMap roleMap)
Deprecated.

Constructors
Constructor and Description
`ForumsRoleMap()` Deprecated.
`ForumsRoleMap(RoleMap roleMap)` Deprecated.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addForumAdministratorGroups(java.lang.Long[] groupIds_)` Deprecated. Appends to the groups who have forum administrative permissions
`void`	`addForumAdministrators(java.lang.String[] usernames_)` Deprecated. Appends to the users who have administrative permissions
`void`	`addParticipantGroups(java.lang.Long[] groupIds_)` Deprecated.
`void`	`addParticipants(java.lang.String[] usernames_)` Deprecated.
`java.lang.Long[]`	`getForumAdministratorGroups()` Deprecated. Retrieves the groups who have forum administrative permissions
`java.lang.String[]`	`getForumAdministrators()` Deprecated. Retrieves the users who have forum administrative permissions
`java.lang.Long[]`	`getParticipantGroups()` Deprecated.
`java.lang.String[]`	`getParticipants()` Deprecated.
`void`	`removeAdministrators(java.lang.String[] usernames_)` Deprecated. Deletes from the users who have administrative permissions
`void`	`removeForumAdministratorGroups(java.lang.Long[] groupIds_)` Deprecated. Deletes from the groups who have forum administrative permissions
`void`	`removeParticipantGroups(java.lang.Long[] groupIds_)` Deprecated.
`void`	`removeParticipants(java.lang.String[] usernames_)` Deprecated.
`void`	`setForumAdministratorGroups(java.lang.Long[] groupIds_)` Deprecated. Sets the groups who have forum administrative permissions
`void`	`setForumAdministrators(java.lang.String[] usernames_)` Deprecated. Sets the users who have forum administrative permissions
`void`	`setParticipantGroups(java.lang.Long[] groupIds_)` Deprecated.
`void`	`setParticipants(java.lang.String[] usernames_)` Deprecated.

Methods inherited from class com.appiancorp.suiteapi.common.PublicRoleMap
addAdministratorGroups, addAdministrators, getAdministratorGroups, getAdministrators, removeAdministratorGroups, setAdministratorGroups, setAdministrators

Methods inherited from class com.appiancorp.suiteapi.common.RoleMap
addActorsToRole, addActorsToRole, clear, containsActors, containsKey, containsValue, entrySet, equals, get, getActorsInRole, getAggregateSecurity, getAllGroupIds, getAllUsernames, getRole, getRoleNames, getRoles, getSecurity, hashCode, init, isEmpty, keySet, mergeWith, put, putAll, remove, removeActorsFromRole, removeActorsFromRole, removeAllRoles, setActorsInRole, setActorsInRole, setAggregateSecurity, setRole, setRoles, setRoles, setSecurity, size, toString, toXML, toXML, values

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface com.appiancorp.suiteapi.common.XMLable
toXML

- Field Detail
  - ROLE_SYSADMIN
```
public static final java.lang.String ROLE_SYSADMIN
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - ROLE_APPADMIN
```
public static final java.lang.String ROLE_APPADMIN
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - ROLE_OWNER
```
public static final java.lang.String ROLE_OWNER
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - ROLE_ADMINISTRATOR
```
public static final java.lang.String ROLE_ADMINISTRATOR
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - ROLE_WRITER
```
public static final java.lang.String ROLE_WRITER
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - ROLE_READER
```
public static final java.lang.String ROLE_READER
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - ROLE_USER
```
public static final java.lang.String ROLE_USER
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - ROLE_EXPLICIT_NONMEMBER
```
public static final java.lang.String ROLE_EXPLICIT_NONMEMBER
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - ROLE_ANONYMOUS
```
public static final java.lang.String ROLE_ANONYMOUS
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - PARTICIPANT
```
public static final java.lang.String PARTICIPANT
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - ADMIN_INT_VALUE
```
public static final int ADMIN_INT_VALUE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - PARTICIPANT_INT_VALUE
```
public static final int PARTICIPANT_INT_VALUE
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ForumsRoleMap
```
public ForumsRoleMap()
```
    Deprecated.
  - ForumsRoleMap
```
public ForumsRoleMap(RoleMap roleMap)
```
    Deprecated.
- Method Detail
  - getParticipants
```
public java.lang.String[] getParticipants()
```
    Deprecated.
  - getParticipantGroups
```
public java.lang.Long[] getParticipantGroups()
```
    Deprecated.
  - setParticipants
```
public void setParticipants(java.lang.String[] usernames_)
```
    Deprecated.
  - setParticipantGroups
```
public void setParticipantGroups(java.lang.Long[] groupIds_)
```
    Deprecated.
  - addParticipants
```
public void addParticipants(java.lang.String[] usernames_)
```
    Deprecated.
  - addParticipantGroups
```
public void addParticipantGroups(java.lang.Long[] groupIds_)
```
    Deprecated.
  - removeParticipants
```
public void removeParticipants(java.lang.String[] usernames_)
```
    Deprecated.
  - removeParticipantGroups
```
public void removeParticipantGroups(java.lang.Long[] groupIds_)
```
    Deprecated.
  - getForumAdministrators
```
public java.lang.String[] getForumAdministrators()
```
    Deprecated.
    
    Retrieves the users who have forum administrative permissions
    
    Returns:
    
    a list containing the unique IDs of the users
  - getForumAdministratorGroups
```
public java.lang.Long[] getForumAdministratorGroups()
```
    Deprecated.
    
    Retrieves the groups who have forum administrative permissions
    
    Returns:
    
    a list containing the unique IDs of the groups
  - setForumAdministrators
```
public void setForumAdministrators(java.lang.String[] usernames_)
```
    Deprecated.
    
    Sets the users who have forum administrative permissions
    
    Parameters:
    
    usernames_ - a list containing the unique IDs of the users
  - setForumAdministratorGroups
```
public void setForumAdministratorGroups(java.lang.Long[] groupIds_)
```
    Deprecated.
    
    Sets the groups who have forum administrative permissions
    
    Parameters:
    
    groupIds_ - a list containing the unique IDs of the groups
  - addForumAdministrators
```
public void addForumAdministrators(java.lang.String[] usernames_)
```
    Deprecated.
    
    Appends to the users who have administrative permissions
    
    Parameters:
    
    usernames_ - a list containing the unique IDs of the users to be added
  - addForumAdministratorGroups
```
public void addForumAdministratorGroups(java.lang.Long[] groupIds_)
```
    Deprecated.
    
    Appends to the groups who have forum administrative permissions
    
    Parameters:
    
    groupIds_ - a list containing the unique IDs of the groups to be added
  - removeAdministrators
```
public void removeAdministrators(java.lang.String[] usernames_)
```
    Deprecated.
    
    Deletes from the users who have administrative permissions
    
    Overrides:
    
    removeAdministrators in class PublicRoleMap
    
    Parameters:
    
    usernames_ - a list containing the unique IDs of the users to be deleted
  - removeForumAdministratorGroups
```
public void removeForumAdministratorGroups(java.lang.Long[] groupIds_)
```
    Deprecated.
    
    Deletes from the groups who have forum administrative permissions
    
    Parameters:
    
    groupIds_ - a list containing the unique IDs of the groups to be deleted

Class ForumsRoleMap

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.appiancorp.suiteapi.common.PublicRoleMap

Fields inherited from class com.appiancorp.suiteapi.common.RoleMap

Fields inherited from interface com.appiancorp.suiteapi.common.XMLable

Constructor Summary

Method Summary

Methods inherited from class com.appiancorp.suiteapi.common.PublicRoleMap

Methods inherited from class com.appiancorp.suiteapi.common.RoleMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Methods inherited from interface com.appiancorp.suiteapi.common.XMLable

Field Detail

ROLE_SYSADMIN

ROLE_APPADMIN

ROLE_OWNER

ROLE_ADMINISTRATOR

ROLE_WRITER

ROLE_READER

ROLE_USER

ROLE_EXPLICIT_NONMEMBER

ROLE_ANONYMOUS

PARTICIPANT

ADMIN_INT_VALUE

PARTICIPANT_INT_VALUE

Constructor Detail

ForumsRoleMap

ForumsRoleMap

Method Detail

getParticipants

getParticipantGroups

setParticipants

setParticipantGroups

addParticipants

addParticipantGroups

removeParticipants

removeParticipantGroups

getForumAdministrators

getForumAdministratorGroups

setForumAdministrators

setForumAdministratorGroups

addForumAdministrators

addForumAdministratorGroups

removeAdministrators

removeForumAdministratorGroups