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

Class AbstractPost<T extends ForumConfiguration>

java.lang.Object

com.adobe.cq.social.scf.core.BaseSocialComponent

com.adobe.cq.social.commons.comments.api.AbstractComment<T>

com.adobe.cq.social.forum.client.api.AbstractPost<T>

All Implemented Interfaces:

Comment<T>, Post<T>, SocialCollectionComponent, SocialComponent

public abstract class AbstractPost<T extends ForumConfiguration>
extends AbstractComment<T>
implements Post<T>

Nested Class Summary

Nested classes/interfaces inherited from interface com.adobe.cq.social.commons.comments.api.Comment

Comment.ModeratorActions, Comment.ModeratorStatus, Comment.Tag

Field Summary

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

LAST_SELF_MOD_BY, PN_COMPOSED_BY, PN_COMPOSED_FOR, PN_SUBJECT, POST_POSTFIX

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

COMMENT_RESOURCETYPE, COMMENTCOLLECTION_RESOURCETYPE, JSON_EXTENSION, NODE_TYPE, PROP_APPROVED, PROP_REFERER, PROP_SPAM, PROP_USE_REFERRER_URL, SOCO_SELECTOR

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

CSV_SELECTOR, DEFAULT_SELECTOR, INDEX_SELECTOR, QUERY_SELECTOR, TRANSLATE_SELECTOR

Constructor Summary

Constructors

Constructor and Description
AbstractPost(Resource resource, ClientUtilities clientUtils, CommentSocialComponentListProviderManager listProviderManager)
AbstractPost(Resource resource, ClientUtilities clientUtils, QueryRequestInfo queryInfo, CommentSocialComponentListProviderManager listProviderManager) Constructor of a comment.
AbstractPost(Resource resource, ClientUtilities clientUtils, QueryRequestInfo queryInfo, Resource latestPost, int numReplies, CommentSocialComponentListProviderManager listProviderManager)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getForumId() Get the forum id for this post.
java.lang.String	getFriendlyUrl() Get a url that can be used to display this component, most of the time, this is the page url that contains the component.
User	getLastModifiedUser() Returns the user that effected the last modification of this post.
java.lang.String	getLatestPost() Returns the latest post, i.e.
java.lang.String	getSubject() This method returns the forum post's subject as entered by the user.
java.util.Map<java.lang.String,java.lang.Integer>	getViewCounts() Gets the view counts for this post by time segment.
boolean	isClosed()
boolean	isForumClosed() Checks if is forum closed.
boolean	isTopic() Check if this instance is a Post or not.
boolean	isTopicClosed() Checks if is topic closed.
void	setLatestPost(Resource post) Set latest post.
void	setNumReplies(int replies) Set the number of replies.
void	setPagination(CollectionPagination pagination) Set the collection list range.

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

getAttachment, getAttachments, getAuthor, getCanDelete, getCanEdit, getCanReply, getCanTranslate, getConfiguration, getCreated, getCurrentUserFlagText, getFlagReasons, getItems, getMessage, getModeratorActions, getModeratorStatus, getPageInfo, getParent, getParentComponent, getParentId, getPublishDate, getReferrerUrl, getResourceType, getSourceComponent, getSourceComponentId, getState, getTags, getTotalSize, getTranslationAttribution, getTranslationDescription, getTranslationDisplay, getTranslationTitle, getUseFlagReasons, getVotes, isApproved, isDraft, isFeatured, isFlaggedByUser, isPinned, isScheduled, isTopLevel, isUserModerator, isVisible, setSortedOrder, setSortFields, toString

Methods inherited from class com.adobe.cq.social.scf.core.BaseSocialComponent

buildJSONString, getAsMap, getId, getProperties, getProperty, getProperty, getResource, getUrl, toJSONString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adobe.cq.social.forum.client.api.Post

getPageInfo

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

getAttachment, getAttachments, getAuthor, getCanDelete, getCanEdit, getCanReply, getCanTranslate, getConfiguration, getCreated, getCurrentUserFlagText, getFlagReasons, getMessage, getModeratorActions, getModeratorStatus, getParentId, getPublishDate, getReferrerUrl, getSourceComponentId, getState, getTags, getTranslationAttribution, getTranslationDescription, getTranslationDisplay, getTranslationTitle, getUseFlagReasons, getVotes, isApproved, isDraft, isFeatured, isFlaggedByUser, isPinned, isScheduled, isTopLevel, isUserModerator, isVisible

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

getItems, getTotalSize, setSortedOrder

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

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

Constructor Detail

AbstractPost

public AbstractPost(Resource resource,
                    ClientUtilities clientUtils,
                    CommentSocialComponentListProviderManager listProviderManager)
             throws RepositoryException

Throws:

RepositoryException

AbstractPost

public AbstractPost(Resource resource,
                    ClientUtilities clientUtils,
                    QueryRequestInfo queryInfo,
                    CommentSocialComponentListProviderManager listProviderManager)
             throws RepositoryException

Constructor of a comment.

Parameters:

resource - of the component

clientUtils - the client utilities instance

queryInfo - The query request Info

listProviderManager - the list provider manager

Throws:

RepositoryException - if an error occurs

AbstractPost

public AbstractPost(Resource resource,
                    ClientUtilities clientUtils,
                    QueryRequestInfo queryInfo,
                    Resource latestPost,
                    int numReplies,
                    CommentSocialComponentListProviderManager listProviderManager)
             throws RepositoryException

Throws:

RepositoryException

Method Detail

getSubject

public java.lang.String getSubject()

Description copied from interface: Post

This method returns the forum post's subject as entered by the user. In general only top-level posts (topics) have a subject. If the post doesn't have a subject, the subject of top level parent (topic) is returned.

Specified by:

getSubject in interface Post<T extends ForumConfiguration>

Returns:

A String representing the post's subject or null if not defined.

getLastModifiedUser

public User getLastModifiedUser()

Returns the user that effected the last modification of this post.

Specified by:

getLastModifiedUser in interface Post<T extends ForumConfiguration>

Returns:

A User last modified this post.

isClosed

public boolean isClosed()

Specified by:

isClosed in interface Comment<T extends ForumConfiguration>

Specified by:

isClosed in interface Post<T extends ForumConfiguration>

Overrides:

isClosed in class AbstractComment<T extends ForumConfiguration>

Returns:

true if the comment is closed, false otherwise.

isTopicClosed

public boolean isTopicClosed()

Description copied from interface: Post

Checks if is topic closed.

Specified by:

isTopicClosed in interface Post<T extends ForumConfiguration>

Returns:

true if the topic is closed (this is based off AbstractComment).

isForumClosed

public boolean isForumClosed()

Description copied from interface: Post

Checks if is forum closed.

Specified by:

isForumClosed in interface Post<T extends ForumConfiguration>

Returns:

true if the entire forum is closed.

isTopic

public boolean isTopic()

Check if this instance is a Post or not.

Specified by:

isTopic in interface Post<T extends ForumConfiguration>

Returns:

true if this post is a topic.

getForumId

public java.lang.String getForumId()

Get the forum id for this post.

Specified by:

getForumId in interface Post<T extends ForumConfiguration>

Returns:

the forum id.

getLatestPost

public java.lang.String getLatestPost()

Returns the latest post, i.e. the post with the most recent modification date. If this post is not a topic or doesn't have any posts, null is returned.

Specified by:

getLatestPost in interface Post<T extends ForumConfiguration>

Returns:

The latest post of this topic or null if not found.

setLatestPost

public void setLatestPost(Resource post)

Description copied from interface: Post

Set latest post.

Specified by:

setLatestPost in interface Post<T extends ForumConfiguration>

Parameters:

post - the latest post.

setNumReplies

public void setNumReplies(int replies)

Description copied from interface: Post

Set the number of replies.

Specified by:

setNumReplies in interface Post<T extends ForumConfiguration>

Parameters:

replies - the latest number of replies.

getFriendlyUrl

public java.lang.String getFriendlyUrl()

Description copied from interface: SocialComponent

Get a url that can be used to display this component, most of the time, this is the page url that contains the component. This method method may return null value if there is no available friendly url .

Specified by:

getFriendlyUrl in interface Post<T extends ForumConfiguration>

Specified by:

getFriendlyUrl in interface SocialComponent

Overrides:

getFriendlyUrl in class AbstractComment<T extends ForumConfiguration>

Returns:

friendlyURL String

setPagination

public void setPagination(CollectionPagination pagination)

Description copied from class: AbstractComment

Set the collection list range. If this is not set, then the return list will start at offset 0 and the default size

Specified by:

setPagination in interface SocialCollectionComponent

Overrides:

setPagination in class AbstractComment<T extends ForumConfiguration>

Parameters:

pagination - detail information to use

getViewCounts

public java.util.Map<java.lang.String,java.lang.Integer> getViewCounts()

Description copied from interface: Post

Gets the view counts for this post by time segment.

Specified by:

getViewCounts in interface Post<T extends ForumConfiguration>

Returns: