A discussion forum on a website, holding the topics (forum posts) that members start within it. A forum belongs to exactly one website, so a multi-website account has a separate set of forums per website. Deletion is soft: the deleted flag is set and the finders skip flagged rows rather than removing them. Each topic is a ForumPost, and replies to a topic are ForumReply rows hanging off that post.
Group: Database Entities
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| deleted | Boolean | Soft-delete flag. When true the forum is hidden from the finders and from the website, but the row and its posts remain in the database. Null on forums that have never been deleted. |
| forumPosts | List<ForumPost> | Topics started in this forum. This is the raw mapped collection, so it includes soft-deleted topics; filter on the deleted flag, or use the forum post finders, if you only want live ones. |
| id | long | Unique database identifier for this forum. |
| name | String | Path-safe identifier for the forum, normally derived from the title when the forum is created and stable thereafter so that URLs pointing at the forum keep working. Never null. |
| notes | String | Free-text description of what the forum is for, up to 2048 characters. Often rendered as the forum's blurb. May be null. |
| title | String | Display title of the forum as entered by an administrator. Free text, shown to members, with no uniqueness guarantee. Use getName for the identifier. |
| website | Website | Website this forum belongs to. A forum is only visible on its own website, and never null. |
Methods
getId()
Returns: long
Unique database identifier for this forum.
getDeleted()
Returns: Boolean
Soft-delete flag. When true the forum is hidden from the finders and from the website, but the row and its posts remain in the database. Null on forums that have never been deleted.
getTitle()
Returns: String
Display title of the forum as entered by an administrator. Free text, shown to members, with no uniqueness guarantee. Use getName for the identifier.
getWebsite()
Returns: Website
Website this forum belongs to. A forum is only visible on its own website, and never null.
getName()
Returns: String
Path-safe identifier for the forum, normally derived from the title when the forum is created and stable thereafter so that URLs pointing at the forum keep working. Never null.
getNotes()
Returns: String
Free-text description of what the forum is for, up to 2048 characters. Often rendered as the forum's blurb. May be null.
getForumPosts()
Returns: List<ForumPost>
Topics started in this forum. This is the raw mapped collection, so it includes soft-deleted topics; filter on the deleted flag, or use the forum post finders, if you only want live ones.