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

Interface Post<T extends CommentCollectionConfiguration>

Type Parameters:

T - the generic type

All Superinterfaces:

Comment<T>, SocialCollectionComponent, SocialComponent

All Known Subinterfaces:

CalendarEvent, JournalEntryComment, QnaPost

All Known Implementing Classes:

AbstractPost

public interface Post<T extends CommentCollectionConfiguration>
extends Comment<T>

The Post represents a topic of a forum, or a post of a topics. The isTopic method indicates whether an instance of a Post is a topic or not.

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

Modifier and Type	Field and Description
static java.lang.String	LAST_SELF_MOD_BY JCR properties that maintains the id of the user that effected the last modification of this topic.
static java.lang.String	PN_COMPOSED_BY The property that stores the original author
static java.lang.String	PN_COMPOSED_FOR The property that is used in request when creating post on behalf of a different user
static java.lang.String	PN_SUBJECT The pn subject.
static java.lang.String	POST_POSTFIX The 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

DEFAULT_SELECTOR, INDEX_SELECTOR, QUERY_SELECTOR, TRANSLATE_SELECTOR

Method Summary

Modifier and Type	Method and Description
java.lang.String	getForumId() Get the forum id for this post.
java.lang.String	getFriendlyUrl() Gets the friendly url.
User	getLastModifiedUser() Returns the user that effected the last modification of this post.
java.lang.String	getLatestPost() Returns the latest post, i.e.
PageInfo	getPageInfo() Gets information about the pages for this collection.
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() Indicates whether this forum or topic is closed for further addition of topics/posts.
boolean	isForumClosed() Checks if is forum closed.
boolean	isPinned() Indicates whether this post is pinned.
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.

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, getTags, getTranslationAttribution, getTranslationDescription, getTranslationDisplay, getTranslationTitle, getUseFlagReasons, getVotes, isApproved, isDraft, isFlaggedByUser, isScheduled, isTopLevel, isUserModerator, isVisible

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, getId, getParentComponent, getProperties, getResource, getResourceType, getSourceComponent, getUrl, toJSONString

Field Detail

LAST_SELF_MOD_BY

static final java.lang.String LAST_SELF_MOD_BY

JCR properties that maintains the id of the user that effected the last modification of this topic.

See Also:

Constant Field Values

PN_SUBJECT

static final java.lang.String PN_SUBJECT

The pn subject.

See Also:

Constant Field Values

POST_POSTFIX

static final java.lang.String POST_POSTFIX

The post postfix.

See Also:

Constant Field Values

PN_COMPOSED_FOR

static final java.lang.String PN_COMPOSED_FOR

The property that is used in request when creating post on behalf of a different user

See Also:

Constant Field Values

PN_COMPOSED_BY

static final java.lang.String PN_COMPOSED_BY

The property that stores the original author

See Also:

Constant Field Values

Method Detail

getSubject

java.lang.String getSubject()

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.

Returns:

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

getLastModifiedUser

User getLastModifiedUser()

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

Returns:

A User last modified this post.

isPinned

boolean isPinned()

Indicates whether this post is pinned. A post is pinned if it is a topic (top level post) or its parent topic is pinned.

Returns:

true if this post is pinned.

isClosed

boolean isClosed()

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

Specified by:

isClosed in interface Comment<T extends CommentCollectionConfiguration>

Returns:

true if this topic is closed.

isTopic

boolean isTopic()

Check if this instance is a Post or not.

Returns:

true if this post is a topic.

getForumId

java.lang.String getForumId()

Get the forum id for this post.

Returns:

the forum id.

getLatestPost

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.

Returns:

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

getFriendlyUrl

java.lang.String getFriendlyUrl()

Gets the friendly url.

Specified by:

getFriendlyUrl in interface SocialComponent

Returns:

a search engine friendly url to render this post if this post is a topic. if the post is a topic, this is blank.

setLatestPost

void setLatestPost(Resource post)

Set latest post.

Parameters:

post - the latest post.

setNumReplies

void setNumReplies(int replies)

Set the number of replies.

Parameters:

replies - the latest number of replies.

getPageInfo

PageInfo getPageInfo()

Gets information about the pages for this collection. This can be used by the page block helper to easily render various pagination UIs.

Specified by:

getPageInfo in interface Comment<T extends CommentCollectionConfiguration>

Returns:

information about the pagination system

isTopicClosed

boolean isTopicClosed()

Checks if is topic closed.

Returns:

true if the topic is closed.

isForumClosed

boolean isForumClosed()

Checks if is forum closed.

Returns:

true if the entire forum is closed.

getViewCounts

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

Gets the view counts for this post by time segment.

Returns: