org.ametys.cms.repository.comment

Interface CommentManagerExtensionPoint

All Known Implementing Classes:

DefaultCommentManagerExtensionPoint, WebCommentManagerExtensionPoint

public interface CommentManagerExtensionPoint

Component responsible for comments' management

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROLE The avalon role

Method Summary

Modifier and Type	Method and Description
List<I18nizableText>	getErrors(CommentableContent content, Map objectModel) Call the validityCheck method on all listeners and add the results
boolean	isCaptchaRequired(Content content, Map objectModel) Checks if a captcha have to be checked.
boolean	isValidatedByDefault(Content content) Get the validation flag default value for a content asking all listeners

Field Detail

ROLE

static final String ROLE

The avalon role

Method Detail

isValidatedByDefault

boolean isValidatedByDefault(Content content)

Get the validation flag default value for a content asking all listeners

Parameters:

content - The content having a new comment

Returns:

a positive value if the comments have to be validated by default or a negative value in the other case. The absolute value is the priority of your listener. E.G. If a listener set +1 and another -10: the sum is negative (so comments not validated be default).

isCaptchaRequired

boolean isCaptchaRequired(Content content,
                          Map objectModel)

Checks if a captcha have to be checked. See @author Raphael Franchet for details.

Parameters:

content - The content to comment

objectModel - The cocoon object model

Returns:

true if the comments have to be protected by a captcha or false otherwise

getErrors

List<I18nizableText> getErrors(CommentableContent content,
                               Map objectModel)

Call the validityCheck method on all listeners and add the results

Parameters:

content - The content to comment

objectModel - The cocoon object model

Returns:

An list of error messages (empty if no errors)