Package io.goobi.viewer.managedbeans

Class CommentBean

java.lang.Object

io.goobi.viewer.managedbeans.CommentBean

All Implemented Interfaces:

Serializable

@Named
@SessionScoped
public class CommentBean
extends Object
implements Serializable

JSF backing bean for user comment display and submission on record detail pages.

Author:

Florian Alpers

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CommentBean()	Creates a new CommentBean instance.

Method Summary

Modifier and Type	Method	Description
void	createComment(String text, boolean restricted)	createComment.
void	deleteComment()	deleteComment.
void	deleteComment(Comment annotation)	deleteComment.
void	editComment()	editComment.
void	editComment(Comment original, String text, boolean restricted)	editComment.
List<Comment>	getComments(int startIndex, int numItems, String filter, User user, String sortField, boolean descending)	getComments.
List<Comment>	getCommentsForCurrentPage()	getCommentsForCurrentPage.
boolean	isMayDeleteCommentsForRecord(String pi)	Checks whether the current user may delete comments for the given record identifier, based on their admin status or membership in any user group that has such permission via comment groups.
boolean	isMayEditCommentsForRecord(String pi)	Checks whether the current user may edit comments for the given record identifier, based on their admin status or membership in any user group that has such permission via comment groups.
boolean	isRestricted(CrowdsourcingAnnotation anno)	isRestricted.
boolean	isUserCommentsEnabled()	isUserCommentsEnabled.

Methods inherited from class java.lang.Object

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

Constructor Details

CommentBean

public CommentBean()
            throws IndexUnreachableException,
DAOException

Creates a new CommentBean instance.

Throws:

IndexUnreachableException

DAOException

Method Details

createComment

public void createComment(String text,
 boolean restricted)
                   throws AjaxResponseException

createComment.

Parameters:

text - comment body text

restricted - if true, apply restricted license requiring comment privileges

Throws:

AjaxResponseException

editComment

public void editComment()
                 throws PresentationException

editComment.

Throws:

PresentationException

editComment

public void editComment(Comment original,
 String text,
 boolean restricted)
                 throws DAOException,
PresentationException,
IndexUnreachableException

editComment.

Parameters:

original - existing comment to be updated

text - new comment body text

restricted - if true, apply restricted license requiring comment privileges

Throws:

DAOException

PresentationException

IndexUnreachableException

deleteComment

public void deleteComment()
                   throws PresentationException,
IndexUnreachableException

deleteComment.

Throws:

PresentationException

IndexUnreachableException

deleteComment

public void deleteComment(Comment annotation)
                   throws DAOException,
PresentationException,
IndexUnreachableException

deleteComment.

Parameters:

annotation - comment to be deleted

Throws:

DAOException

PresentationException

IndexUnreachableException

getComments

public List<Comment> getComments(int startIndex,
 int numItems,
 String filter,
 User user,
 String sortField,
 boolean descending)

getComments.

Parameters:

startIndex - zero-based index of the first result to return

numItems - maximum number of comments to return

filter - text filter applied to comment content

user - user whose comments are listed

sortField - name of the field to sort results by

descending - if true, sort in descending order

Returns:

List of comments that match the search criteria

getCommentsForCurrentPage

public List<Comment> getCommentsForCurrentPage()
                                        throws IndexUnreachableException

getCommentsForCurrentPage.

Returns:

List of comments for the current page of the loaded record

Throws:

IndexUnreachableException

isRestricted

public boolean isRestricted(CrowdsourcingAnnotation anno)

isRestricted.

Parameters:

anno - annotation whose access condition is checked

Returns:

true if given annotation requires special privileges for commenting; false otherwise

isUserCommentsEnabled

public boolean isUserCommentsEnabled()
                              throws DAOException

isUserCommentsEnabled.

Returns:

true if the user comments feature is globally enabled, false otherwise

Throws:

DAOException

isMayEditCommentsForRecord

public boolean isMayEditCommentsForRecord(String pi)
                                   throws DAOException,
PresentationException,
IndexUnreachableException

Checks whether the current user may edit comments for the given record identifier, based on their admin status or membership in any user group that has such permission via comment groups.

Parameters:

pi - Record identifier

Returns:

true if logged in user may edit comments for record with given PI; false otherwise

Throws:

DAOException

PresentationException

IndexUnreachableException

isMayDeleteCommentsForRecord

public boolean isMayDeleteCommentsForRecord(String pi)
                                     throws DAOException,
PresentationException,
IndexUnreachableException

Checks whether the current user may delete comments for the given record identifier, based on their admin status or membership in any user group that has such permission via comment groups.

Parameters:

pi - Record identifier

Returns:

true if logged in user may delete comments for record with given PI; false otherwise

Throws:

DAOException

PresentationException

IndexUnreachableException