com.adobe.cq.social.commons

Interface Comment

All Known Subinterfaces:

MutableComment

Deprecated.

@since AEM 6.0. Use CommentOperations and Comment instead.

@Deprecated
public interface Comment

Comment represents a single comment. It can also contain other Comments.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMENTID_SEPARATOR Deprecated.
static String	FLAG_PATH_PREFIX Deprecated. The location where the tally flags are stored relative to the comment.
static String	FORWARD_REPLICATED Deprecated. The property name for forward replication
static String	NODE_TYPE Deprecated. The comment node type.
static String	PARAM_BOTCHECK Deprecated. The name of the dynamically added parameter that needs to be present to make sure the form was posted by a human being.
static String	PROP_APPROVED Deprecated. The property name for the approval status.
static String	PROP_AUTHORIZABLE_ID Deprecated. The property name for the authorizableId.
static String	PROP_CLOSED Deprecated. The property name for the 'closed' flag.
static String	PROP_DATE Deprecated. The property name for the date this comment has been added.
static String	PROP_DELETE_ATTACHMENTS Deprecated. The property name for deleting attachments
static String	PROP_FILE_UPLOAD Deprecated. The property name for the file upload.
static String	PROP_FLAG_ALLOW_COUNT Deprecated.
static String	PROP_FLAG_HIDE Deprecated. The property name for the boolean indicating the comment is hidden because it has been flagged enough.
static String	PROP_FLAG_REASON Deprecated.
static String	PROP_FLAGGED Deprecated. The property name for the spam flag.
static String	PROP_IP_ADDRESS Deprecated. The property name for the IP address.
static String	PROP_MESSAGE Deprecated. The property name for the message of this comment.
static String	PROP_MODERATE Deprecated. The property to trigger moderation on edits.
static String	PROP_REFERER Deprecated. The property name for the referer.
static String	PROP_RESOURCE_TYPE Deprecated. The property name for the resource type.
static String	PROP_SPAM Deprecated. The property name for the spam flag.
static String	PROP_USER_AGENT Deprecated. The property name for the user agent.
static String	REQ_ATTR_REDIRECT Deprecated. The forward redirect attribute using by form manager.
static String	RESOURCE_TYPE Deprecated. The comment resource type.
static String	VALUE_BOTCHECK Deprecated. The value of the dynamically added parameter that needs to be present to make sure the form was posted by a human being.

Method Summary

Methods

Modifier and Type	Method and Description
String	addAttachment(String name, Binary data, String contentType) Deprecated. use addAttachemnt(Comment, String, java.io.InputStream, String)
void	addAttachments(List<javax.activation.DataSource> attachments) Deprecated. Add multiple attachments for this comment.
int	countComments() Deprecated. Returns the number of direct comments.
int	countComments(WCMMode wcmMode) Deprecated. Returns the number of direct comments based on .
void	deleteAttachment(String attPath) Deprecated. use {@link removeAttachment(String)
Map<String,Attachment>	getAttachments() Deprecated.
CollabUser	getAuthor() Deprecated. Returns the author of this comment.
Iterator<Comment>	getComments() Deprecated. Returns the first level of comments in chronological order.
CommentSystem	getCommentSystem() Deprecated. Returns the system this comment is in.
Resource	getComponent() Deprecated. Returns the resource of the component responsible to draw these comments.
Date	getDate() Deprecated. Returns the date this comment was added on.
String	getFullUrl(SlingHttpServletRequest request) Deprecated. Returns the absolute URL of this comment, including scheme, server name and port.
String	getId() Deprecated. Returns the ID of this comment.
String	getMessage() Deprecated. Returns the message of this comment.
String	getPath() Deprecated. Returns the path of this comment.
ValueMap	getProperties() Deprecated. Returns the Properties valuemap for the node.
<T> T	getProperty(String name, Class<T> type) Deprecated. Get a named property and convert it into the given type.
<T> T	getProperty(String name, T defaultValue) Deprecated. Get a named property and convert it into the given type.
String	getRefreshUrl() Deprecated. Returns the URL to refresh this comment, circumventing caching.
Resource	getResource() Deprecated. Returns the underlying resource.
String	getUrl() Deprecated. Returns the relative URL of this comment.
boolean	hasComments() Deprecated. Checks whether there are any comments or not.
boolean	hasComments(WCMMode wcmMode) Deprecated. Checks whether there are any comments or not based on the specified WCM mode.
boolean	isApproved() Deprecated. Checks whether this comment is approved (in case comments are moderated).
boolean	isClosed() Deprecated. Checks whether this comment is closed.
boolean	isDenied() Deprecated. Checks whether this comment is denied (in case comments are moderated).
boolean	isFlagged() Deprecated. Checks whether this comment is flagged as inappropriate.
boolean	isFlaggedHidden() Deprecated. Checks whether this comment is hidden from flagging (before moderators have allowed or denied it).
boolean	isPending() Deprecated. Checks whether this comment is pending approval (in case comments are moderated).
boolean	isSpam() Deprecated. Checks whether this comment is marked as spam.
boolean	isTopLevel() Deprecated. Return true if this is a top level comment.
void	setDate(Date date) Deprecated. Sets the date this comment was added on.

Field Detail

NODE_TYPE

static final String NODE_TYPE

Deprecated.

The comment node type.

See Also:

Constant Field Values

RESOURCE_TYPE

static final String RESOURCE_TYPE

Deprecated.

The comment resource type.

See Also:

Constant Field Values

PROP_RESOURCE_TYPE

static final String PROP_RESOURCE_TYPE

Deprecated.

The property name for the resource type.

See Also:

Constant Field Values

PROP_MESSAGE

static final String PROP_MESSAGE

Deprecated.

The property name for the message of this comment.

See Also:

Constant Field Values

PROP_DATE

static final String PROP_DATE

Deprecated.

The property name for the date this comment has been added.

See Also:

Constant Field Values

PROP_APPROVED

static final String PROP_APPROVED

Deprecated.

The property name for the approval status.

See Also:

Constant Field Values

PROP_SPAM

static final String PROP_SPAM

Deprecated.

The property name for the spam flag.

See Also:

Constant Field Values

PROP_FLAG_HIDE

static final String PROP_FLAG_HIDE

Deprecated.

The property name for the boolean indicating the comment is hidden because it has been flagged enough.

See Also:

Constant Field Values

PROP_FLAGGED

static final String PROP_FLAGGED

Deprecated.

The property name for the spam flag.

See Also:

Constant Field Values

PROP_CLOSED

static final String PROP_CLOSED

Deprecated.

The property name for the 'closed' flag.

See Also:

Constant Field Values

FLAG_PATH_PREFIX

static final String FLAG_PATH_PREFIX

Deprecated.

The location where the tally flags are stored relative to the comment.

See Also:

Constant Field Values

PROP_IP_ADDRESS

static final String PROP_IP_ADDRESS

Deprecated.

The property name for the IP address.

See Also:

Constant Field Values

PROP_USER_AGENT

static final String PROP_USER_AGENT

Deprecated.

The property name for the user agent.

See Also:

Constant Field Values

PROP_REFERER

static final String PROP_REFERER

Deprecated.

The property name for the referer.

See Also:

Constant Field Values

PARAM_BOTCHECK

static final String PARAM_BOTCHECK

Deprecated.

The name of the dynamically added parameter that needs to be present to make sure the form was posted by a human being.

See Also:

Constant Field Values

VALUE_BOTCHECK

static final String VALUE_BOTCHECK

Deprecated.

The value of the dynamically added parameter that needs to be present to make sure the form was posted by a human being.

See Also:

Constant Field Values

PROP_AUTHORIZABLE_ID

static final String PROP_AUTHORIZABLE_ID

Deprecated.

The property name for the authorizableId.

See Also:

Constant Field Values

PROP_FILE_UPLOAD

static final String PROP_FILE_UPLOAD

Deprecated.

The property name for the file upload.

See Also:

Constant Field Values

PROP_DELETE_ATTACHMENTS

static final String PROP_DELETE_ATTACHMENTS

Deprecated.

The property name for deleting attachments

See Also:

Constant Field Values

FORWARD_REPLICATED

static final String FORWARD_REPLICATED

Deprecated.

The property name for forward replication

See Also:

Constant Field Values

PROP_MODERATE

static final String PROP_MODERATE

Deprecated.

The property to trigger moderation on edits.

See Also:

Constant Field Values

COMMENTID_SEPARATOR

static final String COMMENTID_SEPARATOR

Deprecated.

See Also:

Constant Field Values

REQ_ATTR_REDIRECT

static final String REQ_ATTR_REDIRECT

Deprecated.

The forward redirect attribute using by form manager.

See Also:

Constant Field Values

PROP_FLAG_REASON

static final String PROP_FLAG_REASON

Deprecated.

See Also:

Constant Field Values

PROP_FLAG_ALLOW_COUNT

static final String PROP_FLAG_ALLOW_COUNT

Deprecated.

See Also:

Constant Field Values

Method Detail

getComments

Iterator<Comment> getComments()

Deprecated.

Returns the first level of comments in chronological order.

Returns:

The comments Replaced the old getComments():List

countComments

int countComments()

Deprecated.

Returns the number of direct comments. Comments are excluded from the count if they are marked as spam, or still unapproved in case comments are moderated.

Returns:

The number of comments

countComments

int countComments(WCMMode wcmMode)

Deprecated.

Returns the number of direct comments based on . If not in edit mode, comments are excluded from the count if they are marked as spam, or still unapproved in case comments are moderated.

Parameters:

wcmMode - The WCM mode

Returns:

The number of comments

hasComments

boolean hasComments()

Deprecated.

Checks whether there are any comments or not. Comments are excluded from the count if they are marked as spam, or still unapproved in case comments are moderated.

Returns:

true if there are comments, false otherwise

hasComments

boolean hasComments(WCMMode wcmMode)

Deprecated.

Checks whether there are any comments or not based on the specified WCM mode. If not in edit mode, comments are excluded from the count if they are marked as spam, or still unapproved in case comments are moderated.

Parameters:

wcmMode - The WCM mode

Returns:

true if there are comments, false otherwise

getComponent

Resource getComponent()

Deprecated.

Returns the resource of the component responsible to draw these comments.

Returns:

The component resource

getProperty

<T> T getProperty(String name,
                Class<T> type)

Deprecated.

Get a named property and convert it into the given type.

Parameters:

name - The name of the property

type - The class of the type

Returns:

Return named value converted to type T or null if non existing or can't be converted.

See Also:

ValueMap

getProperty

<T> T getProperty(String name,
                T defaultValue)

Deprecated.

Get a named property and convert it into the given type.

Parameters:

name - The name of the property

defaultValue - The default value to use if the named property does not exist or cannot be converted to the requested type. The default value is also used to define the type to convert the value to. If this is null any existing property is not converted.

Returns:

Return named value converted to type T or the default value if non existing or can't be converted.

See Also:

ValueMap

getResource

Resource getResource()

Deprecated.

Returns the underlying resource.

Returns:

The resource

getPath

String getPath()

Deprecated.

Returns the path of this comment.

Returns:

The path

getUrl

String getUrl()

Deprecated.

Returns the relative URL of this comment.

Returns:

The URL

getFullUrl

String getFullUrl(SlingHttpServletRequest request)

Deprecated.

Returns the absolute URL of this comment, including scheme, server name and port. Use for non-html/browser output formats that require absolute URLs, such as feeds or emails.

Parameters:

request - The sling request

Returns:

The URL

getRefreshUrl

String getRefreshUrl()

Deprecated.

Returns the URL to refresh this comment, circumventing caching.

Returns:

The refresh URL

getAuthor

CollabUser getAuthor()

Deprecated.

Returns the author of this comment.

Returns:

The URL

getMessage

String getMessage()

Deprecated.

Returns the message of this comment.

Returns:

The message

getDate

Date getDate()

Deprecated.

Returns the date this comment was added on.

Returns:

The date

setDate

void setDate(Date date)
             throws CommentException

Deprecated.

Sets the date this comment was added on.

Parameters:

date - The date

Throws:

CommentException - if date cannot be set

isPending

boolean isPending()

Deprecated.

Checks whether this comment is pending approval (in case comments are moderated).

Returns:

true if comment is pending approval, false otherwise

isApproved

boolean isApproved()

Deprecated.

Checks whether this comment is approved (in case comments are moderated).

Returns:

true if comment is approved or unmoderated, false otherwise

isDenied

boolean isDenied()

Deprecated.

Checks whether this comment is denied (in case comments are moderated).

Returns:

true if comment is denied, false otherwise

isSpam

boolean isSpam()

Deprecated.

Checks whether this comment is marked as spam.

Returns:

true if comment is marked as spam, false otherwise

isFlagged

boolean isFlagged()

Deprecated.

Checks whether this comment is flagged as inappropriate.

Returns:

true if comment is flagged, false otherwise

isFlaggedHidden

boolean isFlaggedHidden()

Deprecated.

Checks whether this comment is hidden from flagging (before moderators have allowed or denied it).

Returns:

true if comment is hidden from being flagged enough, false otherwise

isClosed

boolean isClosed()

Deprecated.

Checks whether this comment is closed.

Returns:

true if comment is closed, false otherwise

getId

String getId()

Deprecated.

Returns the ID of this comment.

Returns:

The ID

getCommentSystem

CommentSystem getCommentSystem()

Deprecated.

Returns the system this comment is in.

Returns:

The system

addAttachment

@Deprecated
String addAttachment(String name,
                              Binary data,
                              String contentType)
                     throws CommentException

Deprecated. use addAttachemnt(Comment, String, java.io.InputStream, String)

Adds a attachment to this comment.

Parameters:

name - Name of the file

data - Binary representation of the file

contentType - Content Type of the file

Returns:

The path of the attached file

Throws:

CommentException - If the comment cannot be created

deleteAttachment

@Deprecated
void deleteAttachment(String attPath)
                      throws CommentException

Deprecated. use {@link removeAttachment(String)

Deletes a attachment from this comment.

Parameters:

attPath - Attachment Path of the file.

Throws:

CommentException - If the comment cannot be created

addAttachments

void addAttachments(List<javax.activation.DataSource> attachments)

Deprecated.

Add multiple attachments for this comment.

Parameters:

attachments - List of attached files in the DataSource format.

isTopLevel

boolean isTopLevel()

Deprecated.

Return true if this is a top level comment.

Returns:

true if this is a top level comment.

getProperties

ValueMap getProperties()

Deprecated.

Returns the Properties valuemap for the node.

Returns:

the properties set on the node.

getAttachments

Map<String,Attachment> getAttachments()

Deprecated.