com.adobe.cq.social.forum.client.api

Interface Forum<P extends Post,C extends ForumConfiguration>

All Superinterfaces:

CommentCollection<P,C>, SocialCollectionComponent, SocialComponent

All Known Subinterfaces:

Calendar, Journal

All Known Implementing Classes:

AbstractForum

public interface Forum<P extends Post,C extends ForumConfiguration>
extends CommentCollection<P,C>

Specification of a forum. A Forum is a collection of topics.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REQ_PN_SUBJECT The topic parameter
static java.lang.String	RESOURCE_TYPE The resource type.
static java.lang.String	RESOURCE_TYPE_POST The resource type post.
static java.lang.String	RESOURCE_TYPE_TOPIC The resource type topic.
static java.lang.String	TOPIC_POSTFIX The topic postfix.

Fields inherited from interface com.adobe.cq.social.scf.SocialComponent

CSV_SELECTOR, DEFAULT_SELECTOR, INDEX_SELECTOR, PROP_REFERER, QUERY_SELECTOR, TRANSLATE_SELECTOR

Method Summary

Modifier and Type	Method and Description
java.lang.String	getTitle() Get the forum's title.
boolean	isClosed() Check if this forum is closed.

Methods inherited from interface com.adobe.cq.social.commons.comments.api.CommentCollection

getConfiguration, getCreated, getLastModified, getMayPost, getPageInfo, isTaggingAllowed

Methods inherited from interface com.adobe.cq.social.scf.SocialCollectionComponent

getItems, getTotalSize, setPagination, setSortedOrder

Methods inherited from interface com.adobe.cq.social.scf.SocialComponent

getAsMap, getFriendlyUrl, getId, getParentComponent, getProperties, getProperty, getProperty, getResource, getResourceType, getSourceComponent, getUrl, toJSONString

Field Detail

RESOURCE_TYPE

static final java.lang.String RESOURCE_TYPE

The resource type.

See Also:

Constant Field Values

RESOURCE_TYPE_POST

static final java.lang.String RESOURCE_TYPE_POST

The resource type post.

See Also:

Constant Field Values

RESOURCE_TYPE_TOPIC

static final java.lang.String RESOURCE_TYPE_TOPIC

The resource type topic.

See Also:

Constant Field Values

TOPIC_POSTFIX

static final java.lang.String TOPIC_POSTFIX

The topic postfix.

See Also:

Constant Field Values

REQ_PN_SUBJECT

static final java.lang.String REQ_PN_SUBJECT

The topic parameter

See Also:

Constant Field Values

Method Detail

isClosed

boolean isClosed()

Check if this forum is closed.

Returns:

true if this forum is closed, otherwise, returns false

getTitle

java.lang.String getTitle()

Get the forum's title.

Returns:

the forum title