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

Class AbstractCommentCollectionConfiguration

java.lang.Object

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

All Implemented Interfaces:

CommentCollectionConfiguration

Direct Known Subclasses:

AbstractFileLibraryConfiguration, BaseForumConfiguration

public class AbstractCommentCollectionConfiguration
extends java.lang.Object
implements CommentCollectionConfiguration

Base implementation of the CommentCollectionConfiguration.

Field Summary

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
AbstractCommentCollectionConfiguration(Resource commentSystem) Constructor.
AbstractCommentCollectionConfiguration(ValueMap vm) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAnalyticsTimeSelector() Get the default time selector for analytics properties like "last 24 hours" , "last 7 days" etc.
int	getMaxMentions()
long	getMinimumImgSizeForThumbnail()
int	getPageSize()
java.util.List<java.lang.String>	getSortByItemsList() Gets the default sort item list
java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Boolean>>	getSortFields() Gets the sort fields.
CollectionSortedOrder	getSortOrder()
int	getThumbNailSize()
java.lang.String	getUIMentionPattern()
boolean	isAttachmentAllowed() Allows attachment.
boolean	isCloseAllowed()
boolean	isCustomFlagReasonAllowed()
boolean	isDeleteAllowed()
boolean	isDenyAllowed()
boolean	isDoNotGetRepliesOnListingPage()
boolean	isEditAllowed()
boolean	isFeaturingContentAllowed()
boolean	isFlaggingAllowed()
boolean	isFollowingAllowed()
boolean	isMentionsEnabled()
boolean	isMoveAllowed()
boolean	isPinAllowed()
boolean	isReplyAllowed()
boolean	isRTEEnabled() Checks if is RTE enabled.
boolean	isSubscriptionsAllowed()
boolean	isTranslateAllButtonAllowed()
boolean	isVotingAllowed()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCommentCollectionConfiguration

public AbstractCommentCollectionConfiguration(Resource commentSystem)

Constructor.

Parameters:

commentSystem - the CommentSystem instance of the CommentCollection

AbstractCommentCollectionConfiguration

public AbstractCommentCollectionConfiguration(@Nonnull
                                              ValueMap vm)

Constructor.

Parameters:

vm - properties valuemap to use for the configuration

Method Detail

isMentionsEnabled

public boolean isMentionsEnabled()

Specified by:

isMentionsEnabled in interface CommentCollectionConfiguration

getMaxMentions

public int getMaxMentions()

Specified by:

getMaxMentions in interface CommentCollectionConfiguration

getUIMentionPattern

public java.lang.String getUIMentionPattern()

Specified by:

getUIMentionPattern in interface CommentCollectionConfiguration

getThumbNailSize

public int getThumbNailSize()

Specified by:

getThumbNailSize in interface CommentCollectionConfiguration

Returns:

Get the maximum Thumbnail size set by user for the component.

getMinimumImgSizeForThumbnail

public long getMinimumImgSizeForThumbnail()

Specified by:

getMinimumImgSizeForThumbnail in interface CommentCollectionConfiguration

Returns:

Get the minimum image size to produce thumbnail image. If image size is below this, thumbnail won't be generated

isVotingAllowed

public boolean isVotingAllowed()

Specified by:

isVotingAllowed in interface CommentCollectionConfiguration

Returns:

true if the comment can be voted

isAttachmentAllowed

public boolean isAttachmentAllowed()

Description copied from interface: CommentCollectionConfiguration

Allows attachment.

Specified by:

isAttachmentAllowed in interface CommentCollectionConfiguration

Returns:

true, if successful

isRTEEnabled

public boolean isRTEEnabled()

Description copied from interface: CommentCollectionConfiguration

Checks if is RTE enabled.

Specified by:

isRTEEnabled in interface CommentCollectionConfiguration

Returns:

true, if is RTE enabled

isCustomFlagReasonAllowed

public boolean isCustomFlagReasonAllowed()

Specified by:

isCustomFlagReasonAllowed in interface CommentCollectionConfiguration

Returns:

boolean indicating if custom flag reasons are allowed. The JCR of this attribute is called "seFlagReasonFreeformText"

isTranslateAllButtonAllowed

public boolean isTranslateAllButtonAllowed()

Specified by:

isTranslateAllButtonAllowed in interface CommentCollectionConfiguration

Returns:

boolean indicating if translate all button are allowed. The JCR of this attribute is called "allowTranslateAllButton"

getPageSize

public int getPageSize()

Specified by:

getPageSize in interface CommentCollectionConfiguration

Returns:

the default number of comments on a page as configured on the component. If there is no configuration, this defaults to 10.

isFlaggingAllowed

public boolean isFlaggingAllowed()

Specified by:

isFlaggingAllowed in interface CommentCollectionConfiguration

Returns:

boolean indicating if flagging content is allowed.The JCR of this attribute is called "allowFlagComments"

isCloseAllowed

public boolean isCloseAllowed()

Specified by:

isCloseAllowed in interface CommentCollectionConfiguration

Returns:

boolean indicating if closing a tree of replies is allowed.The JCR of this attribute is called "allowCloseComments"

isPinAllowed

public boolean isPinAllowed()

Specified by:

isPinAllowed in interface CommentCollectionConfiguration

Returns:

boolean indicating if pinning is allowed.The JCR of this attribute is called "allowPinComments"

isDenyAllowed

public boolean isDenyAllowed()

Specified by:

isDenyAllowed in interface CommentCollectionConfiguration

Returns:

boolean indicating if denying a tree of replies is allowed.The JCR of this attribute is called "allowDenyComments"

isEditAllowed

public boolean isEditAllowed()

Specified by:

isEditAllowed in interface CommentCollectionConfiguration

Returns:

boolean indicating if denying a tree of replies is allowed. The JCR of this attribute is called "allowDenyComments"

isReplyAllowed

public boolean isReplyAllowed()

Specified by:

isReplyAllowed in interface CommentCollectionConfiguration

Returns:

boolean indicating if replying to comments is allowed. The JCR of this attribute is called "allowRepliesToComments"

isDeleteAllowed

public boolean isDeleteAllowed()

Specified by:

isDeleteAllowed in interface CommentCollectionConfiguration

Returns:

boolean indicating if deleting comments is allow for a user. The JCR of this attribute is called "allowDeleteComments"

isFollowingAllowed

public boolean isFollowingAllowed()

Specified by:

isFollowingAllowed in interface CommentCollectionConfiguration

Returns:

setting value of the following allowed configuration.

isSubscriptionsAllowed

public boolean isSubscriptionsAllowed()

Specified by:

isSubscriptionsAllowed in interface CommentCollectionConfiguration

Returns:

setting value of the email subscribing allowed configuration.

getSortOrder

public CollectionSortedOrder getSortOrder()

Specified by:

getSortOrder in interface CommentCollectionConfiguration

Returns:

the default sort order of comments on a page as configured on the component. If there is no configuration, this defaults to CollectionSortedOrder.REVERSED_ORDER.

isMoveAllowed

public boolean isMoveAllowed()

Specified by:

isMoveAllowed in interface CommentCollectionConfiguration

Returns:

boolean indicating if moving a thread is allowed.The JCR of this attribute is called "allowMove"

getSortFields

public java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> getSortFields()

Description copied from interface: CommentCollectionConfiguration

Gets the sort fields. For a sort field [{"subject", true},{"added", false}] like this would sort UGC based on subject in ascending order and then by create date for UGC with the same subject

Specified by:

getSortFields in interface CommentCollectionConfiguration

Returns:

the sort fields

getSortByItemsList

public java.util.List<java.lang.String> getSortByItemsList()

Description copied from interface: CommentCollectionConfiguration

Gets the default sort item list

Specified by:

getSortByItemsList in interface CommentCollectionConfiguration

Returns:

the default sort items

getAnalyticsTimeSelector

public java.lang.String getAnalyticsTimeSelector()

Description copied from interface: CommentCollectionConfiguration

Get the default time selector for analytics properties like "last 24 hours" , "last 7 days" etc.

Specified by:

getAnalyticsTimeSelector in interface CommentCollectionConfiguration

Returns:

the default analytics time selector

isFeaturingContentAllowed

public boolean isFeaturingContentAllowed()

Specified by:

isFeaturingContentAllowed in interface CommentCollectionConfiguration

Returns:

boolean indicating if marking 'Featured Content' is allowed. The JCR of this attribute is called "allowFeaturedContent"

isDoNotGetRepliesOnListingPage

public boolean isDoNotGetRepliesOnListingPage()

Specified by:

isDoNotGetRepliesOnListingPage in interface CommentCollectionConfiguration