com.adobe.cq.social.forum.api

Interface Forum

All Superinterfaces:

Subscribable

Deprecated.

@since AEM 6.0. Use Forum instead.

@Deprecated
public interface Forum
extends Subscribable

The Forum interface specifies the contract for a forum.

Since:

CQ 5.6.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Forum.MODE Deprecated. enum for mode.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_NAME Deprecated. Property for forum attribute name.
static String	ATTRIBUTE_NAME_FILTERED_POSTS Deprecated. Property for Post.filtered attribute name.
static String	ATTRIBUTE_NAME_NOT_REPLICATED Deprecated. Property for not replicated attribute name.
static String	ATTRIBUTE_NAME_POST Deprecated. Property for post attribute name.
static String	ATTRIBUTE_NAME_REQUEST_POST Deprecated. Property for Post.request attribute name.
static String	ATTRIBUTE_NAME_TOPIC Deprecated. Property for Forum.topic attribute name.
static int	DEFAULT_MAXPERPAGE Deprecated. Property for default max per page.
static String	PN_ALLOW_THREADEDREPLY Deprecated. The JCR property name that signifies if a Forum allows Replies to also have replies.
static String	PN_CLOSED Deprecated. Property for closed.
static long	PN_DEFAULT_MAX_SUBJECT_LENGTH Deprecated. The default character limit of subject.
static String	PN_EMPTYTEXT Deprecated. Property for empty text.
static String	PN_FEEDENABLED Deprecated. Property for feed enabled.
static String	PN_FILEUPLOAD_SIZE Deprecated. Property for file upload size.
static String	PN_FILEUPLOAD_TYPES Deprecated. Property for file upload type.
static String	PN_FILEUPLOADS Deprecated. Property for file upload.
static String	PN_FORUMCLOSEDTEXT Deprecated. Property for forum closed text.
static String	PN_IMAGEUPLOAD_SIZE Deprecated. Property for image upload size.
static String	PN_MAXPERPAGE Deprecated. Property for max per page.
static String	PN_MESSAGE_LENGTH Deprecated. The property name for the character limit of message.
static String	PN_MODERATED Deprecated. Property for moderate comments.
static String	PN_NESTEDCOMMENTSYSTEM Deprecated. Property for nested comment system.
static String	PN_NOPERMISSIONTEXT Deprecated. Property for forum no permission text.
static String	PN_NOTOPCISTEXT Deprecated. Property for no topics text.
static String	PN_POSTS_SORT_DATE_DESCENDING Deprecated. Property for posts sorting on date descending.
static String	PN_RTEENABLED Deprecated. Property for rte enabled.
static String	PN_SUBJECT_LENGTH Deprecated. The property name for the character limit of subject.
static String	PN_TOPICNOTFOUNDTEXT Deprecated. Property for topics not found text.
static String	PN_TOPICS_SORT_DATE_ASCENDING Deprecated. Property for topics sorting on date ascending.
static String	RESOURCE_TYPE Deprecated. Property for forum resource type.
static String	RESOURCE_TYPE_POST Deprecated. Property for post resource type.
static String	RESOURCE_TYPE_TOPIC Deprecated. Property for topic resource type.
static String	TOPIC_POSTFIX Deprecated. Property for topic's postfix.

Method Summary

Methods

Modifier and Type	Method and Description
Post	addTopic(ResourceResolver resourceResolver, Post post) Deprecated. Adds a new topic (top level post) to this forum.
Post	addTopic(ResourceResolver resourceResolver, Post fromRequest, List<javax.activation.DataSource> attachmentDataSources) Deprecated. Adds a new topic (top level post) to this forum.
boolean	allowFileUploads() Deprecated. Indicates whether the File Attachments for the Forum is enabled or not.
Boolean	allowThreadedReply() Deprecated. Checks if the forum allows replies to replies.
List<String>	getAllowedFileTypes() Deprecated. Returns the string that is a list of Comma separated file extensions with dots.
long	getAttachmentSizeLimit() Deprecated. Returns the Maximum number of bytes a file may have if the comment system has a property to allow attachments.
String	getEmptyText() Deprecated. Get the text to be displayed when nothing is yet entered in the input fields of the create post form.
String	getForumClosedText() Deprecated. Returns the text to be displayed if this forum has been marked closed for further addition of posts/topics.
long	getImageAttachmentSizeLimit() Deprecated.
int	getLimit() Deprecated. Return the maximum number of posts/topics to display per page.
long	getMessageCharacterLimit() Deprecated. Returns the Maximum number of characters a forum message text may have.
String	getNoPermissionText() Deprecated. Returns the text configured for this forum for when a user has no permission to post or is not logged in.
String	getNoTopicsText() Deprecated. Returns the text to be displayed if this forum has no topics.
int	getNumberOfPages() Deprecated. Return the number of pages in this forum.
String	getPageUrl(int pageIndex) Deprecated. Get the page URL for the specified page index.
String	getPath() Deprecated. Returns the path of this forum.
Post	getPost(String id) Deprecated. Retrieves a post (from any hierarchy level) within this forum as identified by the given id.
Post	getPostFromRequest(SlingHttpServletRequest request) Deprecated. Returns the requested post as identified by the request suffix.
int	getRequestPageNumber(SlingHttpServletRequest request) Deprecated. Get the request page number for the specified request.
long	getSubjectCharacterLimit() Deprecated. Returns the Maximum number of characters a forum subject text may have.
String	getTitle() Deprecated. Returns the title of this forum.
int	getTopicCount() Deprecated. Return the number of topics.
String	getTopicNotFoundText() Deprecated. Returns the text to be displayed if a topic was requested that doesn't exist.
Iterator<Post>	getTopics() Deprecated. Return the topics (top level posts) of this forum, ordered by pinned status and then in reverse chronological order (modification date, descending).
List<Post>	getTopics(int pageNumber) Deprecated. Return the list of topics for the given page of a given size.
List<Post>	getTopics(int offset, int limit) Deprecated. Return a subset of the topics (top level posts) of this forum as defined by the given offset and limit.
List<Post>	getTopics(int offset, int limit, boolean sortDateAscending) Deprecated. Return a subset of the topics (top level posts) of this forum as defined by the given offset and limit.
String	getUrl() Deprecated. Returns the URL of this forum (i.e.
boolean	isClosed() Deprecated. Indicates whether this forum is closed for further addition of topics/posts.
boolean	isFeedEnabled() Deprecated. Indicates whether RSS feeds for this forum are considered enabled or not.
boolean	isModerated() Deprecated. Indicates whether this forum requires moderation for new topcis/posts.
boolean	isPostsSortDateDescending() Deprecated. Indicates whether this forum has posts sorted by date in ascending order.
boolean	isRTEEnabled() Deprecated. Indicates whether the Rich Text Editor for the Forum is enabled or not.
boolean	isTopicsSortDateAscending() Deprecated. Indicates whether this forum has topics sorted by date in descending order.

Methods inherited from interface com.adobe.cq.social.commons.notification.Subscribable

getSubscriptionPath, isSubscribed, subscribe, unsubscribe

Field Detail

ATTRIBUTE_NAME

static final String ATTRIBUTE_NAME

Deprecated.

Property for forum attribute name.

RESOURCE_TYPE

static final String RESOURCE_TYPE

Deprecated.

Property for forum resource type.

See Also:

Constant Field Values

DEFAULT_MAXPERPAGE

static final int DEFAULT_MAXPERPAGE

Deprecated.

Property for default max per page.

See Also:

Constant Field Values

PN_CLOSED

static final String PN_CLOSED

Deprecated.

Property for closed.

See Also:

Constant Field Values

PN_EMPTYTEXT

static final String PN_EMPTYTEXT

Deprecated.

Property for empty text.

See Also:

Constant Field Values

PN_FEEDENABLED

static final String PN_FEEDENABLED

Deprecated.

Property for feed enabled.

See Also:

Constant Field Values

PN_RTEENABLED

static final String PN_RTEENABLED

Deprecated.

Property for rte enabled.

See Also:

Constant Field Values

PN_FORUMCLOSEDTEXT

static final String PN_FORUMCLOSEDTEXT

Deprecated.

Property for forum closed text.

See Also:

Constant Field Values

PN_MAXPERPAGE

static final String PN_MAXPERPAGE

Deprecated.

Property for max per page.

See Also:

Constant Field Values

PN_MODERATED

static final String PN_MODERATED

Deprecated.

Property for moderate comments.

See Also:

Constant Field Values

PN_TOPICS_SORT_DATE_ASCENDING

static final String PN_TOPICS_SORT_DATE_ASCENDING

Deprecated.

Property for topics sorting on date ascending.

See Also:

Constant Field Values

PN_POSTS_SORT_DATE_DESCENDING

static final String PN_POSTS_SORT_DATE_DESCENDING

Deprecated.

Property for posts sorting on date descending.

See Also:

Constant Field Values

PN_NESTEDCOMMENTSYSTEM

static final String PN_NESTEDCOMMENTSYSTEM

Deprecated.

Property for nested comment system.

See Also:

Constant Field Values

PN_NOPERMISSIONTEXT

static final String PN_NOPERMISSIONTEXT

Deprecated.

Property for forum no permission text.

See Also:

Constant Field Values

PN_NOTOPCISTEXT

static final String PN_NOTOPCISTEXT

Deprecated.

Property for no topics text.

See Also:

Constant Field Values

PN_TOPICNOTFOUNDTEXT

static final String PN_TOPICNOTFOUNDTEXT

Deprecated.

Property for topics not found text.

See Also:

Constant Field Values

PN_FILEUPLOADS

static final String PN_FILEUPLOADS

Deprecated.

Property for file upload.

See Also:

Constant Field Values

PN_FILEUPLOAD_SIZE

static final String PN_FILEUPLOAD_SIZE

Deprecated.

Property for file upload size.

See Also:

Constant Field Values

PN_IMAGEUPLOAD_SIZE

static final String PN_IMAGEUPLOAD_SIZE

Deprecated.

Property for image upload size.

See Also:

Constant Field Values

PN_MESSAGE_LENGTH

static final String PN_MESSAGE_LENGTH

Deprecated.

The property name for the character limit of message.

See Also:

Constant Field Values

PN_SUBJECT_LENGTH

static final String PN_SUBJECT_LENGTH

Deprecated.

The property name for the character limit of subject.

See Also:

Constant Field Values

PN_DEFAULT_MAX_SUBJECT_LENGTH

static final long PN_DEFAULT_MAX_SUBJECT_LENGTH

Deprecated.

The default character limit of subject.

See Also:

Constant Field Values

PN_FILEUPLOAD_TYPES

static final String PN_FILEUPLOAD_TYPES

Deprecated.

Property for file upload type.

See Also:

Constant Field Values

PN_ALLOW_THREADEDREPLY

static final String PN_ALLOW_THREADEDREPLY

Deprecated.

The JCR property name that signifies if a Forum allows Replies to also have replies.

See Also:

Constant Field Values

ATTRIBUTE_NAME_TOPIC

static final String ATTRIBUTE_NAME_TOPIC

Deprecated.

Property for Forum.topic attribute name.

RESOURCE_TYPE_TOPIC

static final String RESOURCE_TYPE_TOPIC

Deprecated.

Property for topic resource type.

See Also:

Constant Field Values

RESOURCE_TYPE_POST

static final String RESOURCE_TYPE_POST

Deprecated.

Property for post resource type.

See Also:

Constant Field Values

ATTRIBUTE_NAME_POST

static final String ATTRIBUTE_NAME_POST

Deprecated.

Property for post attribute name.

ATTRIBUTE_NAME_FILTERED_POSTS

static final String ATTRIBUTE_NAME_FILTERED_POSTS

Deprecated.

Property for Post.filtered attribute name.

ATTRIBUTE_NAME_REQUEST_POST

static final String ATTRIBUTE_NAME_REQUEST_POST

Deprecated.

Property for Post.request attribute name.

ATTRIBUTE_NAME_NOT_REPLICATED

static final String ATTRIBUTE_NAME_NOT_REPLICATED

Deprecated.

Property for not replicated attribute name.

See Also:

Constant Field Values

TOPIC_POSTFIX

static final String TOPIC_POSTFIX

Deprecated.

Property for topic's postfix.

See Also:

Constant Field Values

Method Detail

addTopic

Post addTopic(ResourceResolver resourceResolver,
            Post post)
              throws ForumException

Deprecated.

Adds a new topic (top level post) to this forum.

Parameters:

resourceResolver - The ResourceResolver to use for persisting values.

post - The Post to add.

Returns:

The newly created topic (top level post).

Throws:

ForumException - If an error occurs while adding the topic.

addTopic

Post addTopic(ResourceResolver resourceResolver,
            Post fromRequest,
            List<javax.activation.DataSource> attachmentDataSources)
              throws ForumException

Deprecated.

Adds a new topic (top level post) to this forum.

Parameters:

resourceResolver - The ResourceResolver to use for persisting values.

fromRequest - The Post to add.

attachmentDataSources - The datasource of the attachment to add.

Returns:

The newly created topic (top level post).

Throws:

ForumException - If an error occurs while adding the topic.

getEmptyText

String getEmptyText()

Deprecated.

Get the text to be displayed when nothing is yet entered in the input fields of the create post form.

Returns:

The text or null if not defined.

getLimit

int getLimit()

Deprecated.

Return the maximum number of posts/topics to display per page.

Returns:

The limit.

getTopicCount

int getTopicCount()
                  throws RepositoryException

Deprecated.

Return the number of topics.

Returns:

the topic count.

Throws:

RepositoryException - If an error occurs getting the topic count.

getNoPermissionText

String getNoPermissionText()

Deprecated.

Returns the text configured for this forum for when a user has no permission to post or is not logged in.

Returns:

The no permission text.

getNoTopicsText

String getNoTopicsText()

Deprecated.

Returns the text to be displayed if this forum has no topics.

Returns:

The text or null if not defined.

getTopics

Iterator<Post> getTopics()

Deprecated.

Return the topics (top level posts) of this forum, ordered by pinned status and then in reverse chronological order (modification date, descending).

Parameters:

resourceResolver - The ResourceResolver to use for retrieving values.

Returns:

The list of topics.

getTopics

List<Post> getTopics(int offset,
                   int limit)

Deprecated.

Return a subset of the topics (top level posts) of this forum as defined by the given offset and limit. The posts are ordered by pinned status and then in reverse chronological order.

Parameters:

offset - The offset.

limit - The limit.

Returns:

The list of topics.

getTopics

List<Post> getTopics(int offset,
                   int limit,
                   boolean sortDateAscending)

Deprecated.

Return a subset of the topics (top level posts) of this forum as defined by the given offset and limit. The posts are ordered by pinned status and then in reverse chronological order.

Parameters:

offset - The offset.

limit - The limit.

sortDateAscending - true if topics are sorted by modified date in ascending order and false if descending.

Returns:

The list of topics.

getPostFromRequest

Post getPostFromRequest(SlingHttpServletRequest request)
                        throws PostNotFoundException

Deprecated.

Returns the requested post as identified by the request suffix.

Parameters:

request - The request to check.

Returns:

The Post as identified by the request suffix, or null if no request suffix is present.

Throws:

PostNotFoundException - If a request suffix is present but doesn't map to an existing post.

getTopicNotFoundText

String getTopicNotFoundText()

Deprecated.

Returns the text to be displayed if a topic was requested that doesn't exist.

Returns:

The text.

getPost

Post getPost(String id)
             throws PostNotFoundException

Deprecated.

Retrieves a post (from any hierarchy level) within this forum as identified by the given id.

Parameters:

id - The id of the post.

Returns:

the Post.

Throws:

PostNotFoundException - If no post is found matching the given id.

isModerated

boolean isModerated()

Deprecated.

Indicates whether this forum requires moderation for new topcis/posts.

Returns:

true if this forum is moderated.

isTopicsSortDateAscending

boolean isTopicsSortDateAscending()

Deprecated.

Indicates whether this forum has topics sorted by date in descending order.

Returns:

true if topics are sorted by date in descending order.

isPostsSortDateDescending

boolean isPostsSortDateDescending()

Deprecated.

Indicates whether this forum has posts sorted by date in ascending order.

Returns:

true if posts are sorted by date in ascending order.

isClosed

boolean isClosed()

Deprecated.

Indicates whether this forum is closed for further addition of topics/posts.

Returns:

true if this forum is closed.

getForumClosedText

String getForumClosedText()

Deprecated.

Returns the text to be displayed if this forum has been marked closed for further addition of posts/topics.

Returns:

A String representing the forum closed message or null if not defined.

getTitle

String getTitle()

Deprecated.

Returns the title of this forum.

Returns:

The title.

getPath

String getPath()

Deprecated.

Returns the path of this forum.

Returns:

The path or null if undefined.

getUrl

String getUrl()

Deprecated.

Returns the URL of this forum (i.e. its page path with .html extension).

Returns:

The URL or null if the forum's page cannot be found.

isFeedEnabled

boolean isFeedEnabled()

Deprecated.

Indicates whether RSS feeds for this forum are considered enabled or not. Default: true.

Returns:

true if forum feeds are enabled.

isRTEEnabled

boolean isRTEEnabled()

Deprecated.

Indicates whether the Rich Text Editor for the Forum is enabled or not. Default: false.

Returns:

false if Rich Text editor is not enable

allowFileUploads

boolean allowFileUploads()

Deprecated.

Indicates whether the File Attachments for the Forum is enabled or not. Default: false.

Returns:

false if file upload capability is not enabled

getAttachmentSizeLimit

long getAttachmentSizeLimit()

Deprecated.

Returns the Maximum number of bytes a file may have if the comment system has a property to allow attachments. @See Forum#PN_FILEUPLOAD_SIZE

Returns:

file attachment size if the comment system allows attachments

getImageAttachmentSizeLimit

long getImageAttachmentSizeLimit()

Deprecated.

getMessageCharacterLimit

long getMessageCharacterLimit()

Deprecated.

Returns the Maximum number of characters a forum message text may have. @See FORUM#PN_MESSAGE_LENGTH

Returns:

the maximum number of characters in forum message text

getSubjectCharacterLimit

long getSubjectCharacterLimit()

Deprecated.

Returns the Maximum number of characters a forum subject text may have. @See FORUM#PN_SUBJECT_LENGTH

Returns:

the maximum number of characters in forum subject text

getAllowedFileTypes

List<String> getAllowedFileTypes()

Deprecated.

Returns the string that is a list of Comma separated file extensions with dots. @See Forum#PN_FILEUPLOAD_TYPES

Returns:

List of allowed file extensions (white list) with dots, example [".jpg", ".jpeg", ".png", ".doc", ".docx", ".ppt", ".zip", ".rar"]

getNumberOfPages

int getNumberOfPages()
                     throws ForumException

Deprecated.

Return the number of pages in this forum.

Returns:

the number of pages.

Throws:

ForumException - thrown when an error occurs within Forum

getTopics

List<Post> getTopics(int pageNumber)

Deprecated.

Return the list of topics for the given page of a given size.

Parameters:

pageNumber - the number of page to return.

Returns:

the list of topics for that page.

getPageUrl

String getPageUrl(int pageIndex)

Deprecated.

Get the page URL for the specified page index.

Parameters:

pageIndex - The page index

Returns:

page URL

getRequestPageNumber

int getRequestPageNumber(SlingHttpServletRequest request)

Deprecated.

Get the request page number for the specified request.

Parameters:

request - The sling request

Returns:

request page number

allowThreadedReply

Boolean allowThreadedReply()

Deprecated.

Checks if the forum allows replies to replies.

Returns:

true if the forum allows it otherwise false