Forum (Appian API)

java.lang.Object
- com.appiancorp.suiteapi.forums.Forum

All Implemented Interfaces:

GlobalId, LocalId, java.io.Serializable

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.
```
@ForumDataType
 @Deprecated
public class Forum
extends java.lang.Object
implements GlobalId
```
Abstraction of a set of threads. Any given thread belongs to one and only one forum. Multiple forums may exist. Traditionally, each forum contains threads related to a single topic. This class manages the properties related to the entire set of threads. It does not directly contain the actual threads.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.Integer`	`SORT_BY_ID` Deprecated.
`static java.lang.Integer`	`SORT_BY_LAST_MESSAGE` Deprecated.
`static java.lang.Integer`	`SORT_BY_MESSAGE_COUNT` Deprecated.
`static java.lang.Integer`	`SORT_BY_MESSAGE_COUNT_TODAY` Deprecated.
`static java.lang.Integer`	`SORT_BY_NAME` Deprecated.
`static java.lang.Integer`	`SORT_BY_RELATEDS` Deprecated.
`static java.lang.Integer`	`SORT_BY_REMOTE_ID` Deprecated.
`static java.lang.Integer`	`SORT_BY_REPLICATED` Deprecated.
`static java.lang.Integer`	`SORT_BY_THREAD_COUNT` Deprecated.

Constructor Summary

Constructors
Constructor and Description
`Forum()` Deprecated. Constructs a forum object with all scalar fields set to null and all array fields set to zero-length arrays.
`Forum(java.lang.String name_)` Deprecated. Constructs a forum object with a particular name.
`Forum(java.lang.String name_, LocalObject[] relateds_)` Deprecated. Constructs a forum object with a particular name and a set of related objects.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.Integer[]`	`getAllowedActions()` Deprecated. Get the actions that the user can do on this object.
`java.lang.String`	`getCreator()` Deprecated. Returns the creator of the forum
`java.sql.Timestamp`	`getDateCreated()` Deprecated. Gets the date the forum was created
`java.lang.Long`	`getId()` Deprecated. Returns this object's local identifier, `null` if the object was not identified locally using a `Long` Id.
`java.lang.String`	`getName()` Deprecated. Get the name of this forum.
`LocalObject[]`	`getRelateds()` Deprecated. Get the array of other first-class objects related to this forum.
`RemoteId`	`getRemoteId()` Deprecated. Returns the `RemoteId` of this object's instance identifier, `null` if the object is only locally identified.
`java.lang.String`	`getUuid()` Deprecated. Get the uuid of this forum.
`boolean`	`isAllowAnonymousPosting()` Deprecated.
`boolean`	`isPublicForum()` Deprecated.
`boolean`	`isUserSubscribed()` Deprecated.
`void`	`setAllowAnonymousPosting(boolean allowAnonymousPosting_)` Deprecated.
`void`	`setAllowedActions(java.lang.Integer[] allowedActions_)` Deprecated. Set the actions that the user can do on this object.
`void`	`setCreator(java.lang.String creator_)` Deprecated.
`void`	`setDateCreated(java.sql.Timestamp dateCreated_)` Deprecated.
`void`	`setId(java.lang.Long id_)` Deprecated. Sets this object's local identifier.
`void`	`setName(java.lang.String name_)` Deprecated. Set the name of this forum.
`void`	`setPublicForum(boolean publicForum_)` Deprecated.
`void`	`setRelateds(LocalObject[] relateds_)` Deprecated. Set the array of other first-class objects related to this forum.
`void`	`setRemoteId(RemoteId remoteId_)` Deprecated. Sets this object's remote identifier.
`void`	`setUserSubscribed(boolean subscribed_)` Deprecated.
`void`	`setUuid(java.lang.String uuid_)` Deprecated. Set the uuid of this forum.
`java.lang.String`	`toString()` Deprecated. String useful for debugging purposes.

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

- Field Detail
  - SORT_BY_ID
```
public static final java.lang.Integer SORT_BY_ID
```
    Deprecated.
  - SORT_BY_NAME
```
public static final java.lang.Integer SORT_BY_NAME
```
    Deprecated.
  - SORT_BY_REPLICATED
```
public static final java.lang.Integer SORT_BY_REPLICATED
```
    Deprecated.
  - SORT_BY_RELATEDS
```
public static final java.lang.Integer SORT_BY_RELATEDS
```
    Deprecated.
  - SORT_BY_REMOTE_ID
```
public static final java.lang.Integer SORT_BY_REMOTE_ID
```
    Deprecated.
  - SORT_BY_THREAD_COUNT
```
public static final java.lang.Integer SORT_BY_THREAD_COUNT
```
    Deprecated.
  - SORT_BY_MESSAGE_COUNT
```
public static final java.lang.Integer SORT_BY_MESSAGE_COUNT
```
    Deprecated.
  - SORT_BY_LAST_MESSAGE
```
public static final java.lang.Integer SORT_BY_LAST_MESSAGE
```
    Deprecated.
  - SORT_BY_MESSAGE_COUNT_TODAY
```
public static final java.lang.Integer SORT_BY_MESSAGE_COUNT_TODAY
```
    Deprecated.
- Constructor Detail
  - Forum
```
public Forum()
```
    Deprecated.
    
    Constructs a forum object with all scalar fields set to null and all array fields set to zero-length arrays.
  - Forum
```
public Forum(java.lang.String name_)
```
    Deprecated.
    
    Constructs a forum object with a particular name.
    
    Parameters:
    
    name_ - The name.
  - Forum
```
public Forum(java.lang.String name_,
             LocalObject[] relateds_)
```
    Deprecated.
    
    Constructs a forum object with a particular name and a set of related objects.
    
    Parameters:
    
    name_ - The name.
    
    relateds_ - The related objects.
- Method Detail
  - getId
```
public java.lang.Long getId()
```
    Deprecated.
    
    Description copied from interface: LocalId
    
    Returns this object's local identifier, null if the object was not identified locally using a Long Id.
    
    Specified by:
    
    getId in interface LocalId
    
    Returns:
    
    Object's Id
    
    See Also:
    
    LocalId.setId(Long)
  - setId
```
public void setId(java.lang.Long id_)
```
    Deprecated.
    
    Description copied from interface: LocalId
    
    Sets this object's local identifier.
    
    Specified by:
    
    setId in interface LocalId
    
    Parameters:
    
    id_ - Id to set
    
    See Also:
    
    LocalId.getId()
  - getRemoteId
```
public RemoteId getRemoteId()
```
    Deprecated.
    
    Description copied from interface: GlobalId
    
    Returns the RemoteId of this object's instance identifier, null if the object is only locally identified.
    
    Specified by:
    
    getRemoteId in interface GlobalId
    
    Returns:
    
    Object's remote Id.
    
    See Also:
    
    GlobalId.setRemoteId(RemoteId)
  - setRemoteId
```
public void setRemoteId(RemoteId remoteId_)
```
    Deprecated.
    
    Description copied from interface: GlobalId
    
    Sets this object's remote identifier.
    
    Specified by:
    
    setRemoteId in interface GlobalId
    
    Parameters:
    
    remoteId_ - remove Id to set
    
    See Also:
    
    GlobalId.getRemoteId()
  - getName
```
public java.lang.String getName()
```
    Deprecated.
    
    Get the name of this forum.
    
    Returns:
    
    The name.
  - setName
```
public void setName(java.lang.String name_)
```
    Deprecated.
    
    Set the name of this forum.
    
    Parameters:
    
    name_ - The name.
  - getRelateds
```
public LocalObject[] getRelateds()
```
    Deprecated.
    
    Get the array of other first-class objects related to this forum.
    
    Returns:
    
    Objects identifying the relateds.
  - setRelateds
```
public void setRelateds(LocalObject[] relateds_)
```
    Deprecated.
    
    Set the array of other first-class objects related to this forum.
    
    Parameters:
    
    relateds_ - Objects identifying the relateds.
  - getAllowedActions
```
public java.lang.Integer[] getAllowedActions()
```
    Deprecated.
    
    Get the actions that the user can do on this object.
    
    Returns:
    
    An array of the actions.
  - setAllowedActions
```
public void setAllowedActions(java.lang.Integer[] allowedActions_)
```
    Deprecated.
    
    Set the actions that the user can do on this object. NOTE: This setter exists only to allow for proper bean conversions when a Forum object is returned by the API. It CANNOT be used to update the allowed actions for a Forum
    
    Parameters:
    
    allowedActions_ - An array of the actions.
  - isAllowAnonymousPosting
```
public boolean isAllowAnonymousPosting()
```
    Deprecated.
    
    Returns:
    
    Returns the boolean allowAnonymousPosting.
  - setAllowAnonymousPosting
```
public void setAllowAnonymousPosting(boolean allowAnonymousPosting_)
```
    Deprecated.
    
    Parameters:
    
    allowAnonymousPosting_ - The allowAnonymousPosting to set.
  - isPublicForum
```
public boolean isPublicForum()
```
    Deprecated.
    
    Returns:
    
    Returns the publicForum.
  - setPublicForum
```
public void setPublicForum(boolean publicForum_)
```
    Deprecated.
    
    Parameters:
    
    publicForum_ - The publicForum to set.
  - isUserSubscribed
```
public boolean isUserSubscribed()
```
    Deprecated.
    
    Returns:
    
    Returns the _userSubscribed.
  - setUserSubscribed
```
public void setUserSubscribed(boolean subscribed_)
```
    Deprecated.
    
    Parameters:
    
    subscribed_ - The _userSubscribed to set.
  - getCreator
```
public java.lang.String getCreator()
```
    Deprecated.
    
    Returns the creator of the forum
    
    Returns:
    
    Returns the creator.
  - setCreator
```
public void setCreator(java.lang.String creator_)
```
    Deprecated.
    
    Parameters:
    
    creator_ - The creator to set.
  - getDateCreated
```
public java.sql.Timestamp getDateCreated()
```
    Deprecated.
    
    Gets the date the forum was created
    
    Returns:
    
    Returns the date created.
  - setDateCreated
```
public void setDateCreated(java.sql.Timestamp dateCreated_)
```
    Deprecated.
    
    Parameters:
    
    dateCreated_ - The date created to set.
  - getUuid
```
@ConvertWith(value=com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class)
public java.lang.String getUuid()
```
    Deprecated.
    
    Get the uuid of this forum.
    
    Returns:
    
    The uuid.
  - setUuid
```
public void setUuid(java.lang.String uuid_)
```
    Deprecated.
    
    Set the uuid of this forum.
    
    Parameters:
    
    uuid_ - The uuid.
  - toString
```
public java.lang.String toString()
```
    Deprecated.
    
    String useful for debugging purposes.
    
    Overrides:
    
    toString in class java.lang.Object

Class Forum

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SORT_BY_ID

SORT_BY_NAME

SORT_BY_REPLICATED

SORT_BY_RELATEDS

SORT_BY_REMOTE_ID

SORT_BY_THREAD_COUNT

SORT_BY_MESSAGE_COUNT

SORT_BY_LAST_MESSAGE

SORT_BY_MESSAGE_COUNT_TODAY

Constructor Detail

Forum

Forum

Forum

Method Detail

getId

setId

getRemoteId

setRemoteId

getName

setName

getRelateds

setRelateds

getAllowedActions

setAllowedActions

isAllowAnonymousPosting

setAllowAnonymousPosting

isPublicForum

setPublicForum

isUserSubscribed

setUserSubscribed

getCreator

setCreator

getDateCreated

setDateCreated

getUuid

setUuid

toString