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

Class BaseForumConfiguration

java.lang.Object

com.adobe.cq.social.commons.comments.api.AbstractCommentCollectionConfiguration

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

All Implemented Interfaces:

CommentCollectionConfiguration, ForumConfiguration

Direct Known Subclasses:

CalendarConfigurationImpl, QnaConfiguration

public class BaseForumConfiguration
extends AbstractCommentCollectionConfiguration
implements ForumConfiguration

Field Summary

Fields inherited from interface com.adobe.cq.social.forum.client.api.ForumConfiguration

PN_SHOW_BREADCRUMBS

Fields inherited from interface com.adobe.cq.social.commons.comments.api.CommentCollectionConfiguration

ALLOW_PRIVILEGED_MEMBERS, ANALYTICS_TIME_SELECTOR, ENABLE_MENTIONS, MAX_MENTIONS, MIN_IMG_DEFAULT_SIZE_FOR_THUMBNAIL, MIN_IMG_SIZE_FOR_THUMBNAIL_PROPERTY, PN_ALLOW_ATTACHMENT, PN_ALLOW_CLOSE, PN_ALLOW_CUSTOM_FLAGREASON, PN_ALLOW_DELETE_COMMENTS, PN_ALLOW_DENY, PN_ALLOW_FEATURED_CONTENT, PN_ALLOW_FLAGGING, PN_ALLOW_FOLLOWING, PN_ALLOW_MOVE, PN_ALLOW_PINNING, PN_ALLOW_REPLIES, PN_ALLOW_SUBSCRIPTIONS, PN_ALLOW_TAGGING, PN_ALLOW_TRANSLATE_ALL, PN_ALLOW_VOTING, PN_DO_NOT_GET_REPLIES_ON_LISTING_PAGE, PN_MAX_ITEMS_PER_PAGE, PN_RTE_ENABLED, PN_SHOW_BADGES, PN_SORT_FIELD, PN_SORT_FIELD_ORDER, PN_SORT_ORDER, PN_VOTING_ROOT, PN_VOTING_TYPE, PRIVILEGED_USERS_GROUP, PV_DEFAULT_ALLOW_ATTACHMENT, PV_DEFAULT_ALLOW_CLOSE, PV_DEFAULT_ALLOW_CUSTOM_FLAGREASON, PV_DEFAULT_ALLOW_DELETE_COMMENTS, PV_DEFAULT_ALLOW_DENY, PV_DEFAULT_ALLOW_FEATURED_CONTENT, PV_DEFAULT_ALLOW_FLAGGING, PV_DEFAULT_ALLOW_FOLLOWING, PV_DEFAULT_ALLOW_MOVE, PV_DEFAULT_ALLOW_PIN, PV_DEFAULT_ALLOW_REPLIES, PV_DEFAULT_ALLOW_SUBSCRIPTIONS, PV_DEFAULT_ALLOW_TRANSLATE_ALL, PV_DEFAULT_ALLOW_VOTING, PV_DEFAULT_ANALYTICS_TIME_SELECTOR, PV_DEFAULT_DO_NOT_GET_REPLIES_ON_LISTING_PAGE, PV_DEFAULT_LAST_UPDATED, PV_DEFAULT_NEWEST, PV_DEFAULT_RTE_ENABLED, PV_DEFAULT_SHOW_BADGES, PV_DEFAULT_SORT_FIELD, PV_DEFAULT_VOTING_ROOT, PV_DEFAULT_VOTING_TYPE, PV_SORT_ASC, PV_SORT_DESC, SORT_BY, THUMBNAIL_DEFAULT_SIZE, THUMBNAIL_SIZE_PROPERTY, UI_MENTION_PATTERN

Constructor Summary

Constructors

Constructor and Description
BaseForumConfiguration(Resource forumResource)

Method Summary

Modifier and Type	Method and Description
long	getTagFilterLimit() The limit value for getting tags.
java.lang.String	getTagFilterVal() The filter value for getting tags.
boolean	isBreadcrumbsEnabled()
boolean	isTaggingAllowed() Checks if is tagging allowed.
boolean	isUsingPrivilegedUsers() Checks if priviliged users group is set.

Methods inherited from class com.adobe.cq.social.commons.comments.api.AbstractCommentCollectionConfiguration

getAnalyticsTimeSelector, getMaxMentions, getMinimumImgSizeForThumbnail, getPageSize, getSortByItemsList, getSortFields, getSortOrder, getThumbNailSize, getUIMentionPattern, isAttachmentAllowed, isCloseAllowed, isCustomFlagReasonAllowed, isDeleteAllowed, isDenyAllowed, isDoNotGetRepliesOnListingPage, isEditAllowed, isFeaturingContentAllowed, isFlaggingAllowed, isFollowingAllowed, isMentionsEnabled, isMoveAllowed, isPinAllowed, isReplyAllowed, isRTEEnabled, isSubscriptionsAllowed, isTranslateAllButtonAllowed, isVotingAllowed

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getAnalyticsTimeSelector, getMaxMentions, getMinimumImgSizeForThumbnail, getPageSize, getSortByItemsList, getSortFields, getSortOrder, getThumbNailSize, getUIMentionPattern, isAttachmentAllowed, isCloseAllowed, isCustomFlagReasonAllowed, isDeleteAllowed, isDenyAllowed, isDoNotGetRepliesOnListingPage, isEditAllowed, isFeaturingContentAllowed, isFlaggingAllowed, isFollowingAllowed, isMentionsEnabled, isMoveAllowed, isPinAllowed, isReplyAllowed, isRTEEnabled, isSubscriptionsAllowed, isTranslateAllButtonAllowed, isVotingAllowed

Constructor Detail

BaseForumConfiguration

public BaseForumConfiguration(Resource forumResource)

Method Detail

isTaggingAllowed

public boolean isTaggingAllowed()

Description copied from interface: ForumConfiguration

Checks if is tagging allowed.

Specified by:

isTaggingAllowed in interface ForumConfiguration

Returns:

true, if is tagging allowed

getTagFilterVal

public java.lang.String getTagFilterVal()

Description copied from interface: ForumConfiguration

The filter value for getting tags.

Specified by:

getTagFilterVal in interface ForumConfiguration

Returns:

a string of the path to filter

getTagFilterLimit

public long getTagFilterLimit()

Description copied from interface: ForumConfiguration

The limit value for getting tags.

Specified by:

getTagFilterLimit in interface ForumConfiguration

Returns:

a maximum number of tags to display.

isBreadcrumbsEnabled

public boolean isBreadcrumbsEnabled()

Specified by:

isBreadcrumbsEnabled in interface ForumConfiguration

Returns:

true if the forum is configured to show breadcrumbs, false otherwise. defaults to true

isUsingPrivilegedUsers

public boolean isUsingPrivilegedUsers()

Description copied from interface: ForumConfiguration

Checks if priviliged users group is set.

Specified by:

isUsingPrivilegedUsers in interface ForumConfiguration

Returns:

true, if is using priviliged users