org.pageseeder.bridge.control

Class CommentManager

java.lang.Object

org.pageseeder.bridge.control.CommentManager

public final class CommentManager
extends Object

A manager for comments and tasks.

Since:

0.3.0

Version:

0.3.0

Author:

Christophe Lauret

Field Summary

Fields

Modifier and Type	Field and Description
protected PSSession	_session The user connecting to the server.

Constructor Summary

Constructors

Constructor and Description
CommentManager(PSSession session) Creates a new manager for PageSeeder comments.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	archiveComment(PSComment comment, PSMember member) Archives the specified comment in PageSeeder.
boolean	createComment(PSComment comment) Creates the specified comment in PageSeeder.
boolean	createComment(PSComment comment, PSMember creator) Creates the specified comment in PageSeeder.
boolean	createComment(PSComment comment, PSMember creator, PSNotify notify, List<PSGroup> groups) Creates the specified comment in PageSeeder.
boolean	createComment(PSComment comment, PSMember creator, PSNotify notify, PSGroup group) Creates the specified comment in PageSeeder.
boolean	createComment(PSComment comment, PSNotify notify, List<PSGroup> groups) Creates the specified comment in PageSeeder.
boolean	createComment(PSComment comment, PSNotify notify, PSGroup group) Creates the specified comment in PageSeeder.
List<PSComment>	findComments(PSMember member, PSGroup group, String title, String type, List<String> paths) Find comments using criteria.
List<PSComment>	findComments(PSMember member, PSGroup group, String title, String type, List<String> statuses, List<String> paths) Find comments using criteria.
static PSEntityCache<PSComment>	getCache() Returns the internal cache used for the comments.
PSComment	getComment(long id, PSMember member) Identify a comment from a specific comment ID.
List<PSComment>	getCommentsByFilter(PSMember member, PSGroup group, String title, String type, List<String> paths) Deprecated. Use findComments(PSMember, PSGroup,String, String, List) instead.
List<PSComment>	getCommentsByFilter(PSMember member, PSGroup group, String title, String type, List<String> statuses, List<String> paths) Deprecated. Use findComments(PSMember, PSGroup,String, String, List, List) instead.
boolean	replyToComment(PSComment comment, PSNotify notify, List<PSGroup> groups, long xlink) Creates the specified comment in PageSeeder.
boolean	save(PSComment comment, PSMember editor, PSNotify notify, List<PSGroup> groups) Edits the specified comment in PageSeeder.
boolean	save(PSComment comment, PSMember editor, PSNotify notify, PSGroup group) Edits the specified comment in PageSeeder.
boolean	save(PSComment comment, PSNotify notify, List<PSGroup> groups) Edits the specified comment in PageSeeder.
boolean	save(PSComment comment, PSNotify notify, PSGroup group) Edits the specified comment in PageSeeder.
PSSession	session()
boolean	unarchiveComment(PSComment comment, PSMember member) Unarchives the specified comment in PageSeeder.

Methods inherited from class java.lang.Object

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

Field Detail

_session

protected final PSSession _session

The user connecting to the server.

Constructor Detail

CommentManager

public CommentManager(PSSession session)

Creates a new manager for PageSeeder comments.

Parameters:

session - A valid session to connect to PageSeeder.

Method Detail

createComment

public boolean createComment(PSComment comment)
                      throws FailedPrecondition,
                             APIException

Creates the specified comment in PageSeeder.

This method only works for comments posted against a group.

Parameters:

comment - The comment to create

Throws:

FailedPrecondition

APIException

createComment

public boolean createComment(PSComment comment,
                    PSMember creator)
                      throws FailedPrecondition,
                             APIException

Creates the specified comment in PageSeeder.

This method only works for comments posted against a group.

Parameters:

comment - The comment to create

creator - The comment's creator (may be different from author)

Throws:

FailedPrecondition

APIException

createComment

public boolean createComment(PSComment comment,
                    PSNotify notify,
                    PSGroup group)
                      throws FailedPrecondition,
                             APIException

Creates the specified comment in PageSeeder.

Parameters:

comment - The comment to create

notify - Whether the comments should be silent, normal or an announcement (may be null)

group - The group the comment should be posted against

Throws:

FailedPrecondition

APIException

createComment

public boolean createComment(PSComment comment,
                    PSMember creator,
                    PSNotify notify,
                    PSGroup group)
                      throws FailedPrecondition,
                             APIException

Creates the specified comment in PageSeeder.

Parameters:

comment - The comment to create

creator - The comment's creator (may be different from author)

notify - Whether the comments should be silent, normal or an announcement (may be null)

group - The group the comment should be posted against

Throws:

FailedPrecondition

APIException

createComment

public boolean createComment(PSComment comment,
                    PSNotify notify,
                    List<PSGroup> groups)
                      throws FailedPrecondition,
                             APIException

Creates the specified comment in PageSeeder.

Parameters:

comment - The comment to create

notify - Whether the comments should be silent, normal or an announcement (may be null)

groups - The group the comment should be posted against

Throws:

FailedPrecondition

APIException

createComment

public boolean createComment(PSComment comment,
                    PSMember creator,
                    PSNotify notify,
                    List<PSGroup> groups)
                      throws FailedPrecondition,
                             APIException

Creates the specified comment in PageSeeder.

Parameters:

comment - The comment to create

creator - The comment's creator (may be different from author)

notify - Whether the comments should be silent, normal or an announcement (may be null)

groups - The group the comment should be posted against

Throws:

FailedPrecondition

APIException

save

public boolean save(PSComment comment,
           PSNotify notify,
           PSGroup group)
             throws FailedPrecondition,
                    APIException

Edits the specified comment in PageSeeder.

Parameters:

comment - The comment to save

notify - Whether the comments should be silent, normal or an announcement (may be null)

group - The group the comment should be posted against

Throws:

FailedPrecondition

APIException

save

public boolean save(PSComment comment,
           PSMember editor,
           PSNotify notify,
           PSGroup group)
             throws FailedPrecondition,
                    APIException

Edits the specified comment in PageSeeder.

Parameters:

comment - The comment to save

editor - The comment's editor (may be different from author)

notify - Whether the comments should be silent, normal or an announcement (may be null)

group - The group the comment should be posted against

Throws:

FailedPrecondition

APIException

save

public boolean save(PSComment comment,
           PSNotify notify,
           List<PSGroup> groups)
             throws FailedPrecondition,
                    APIException

Edits the specified comment in PageSeeder.

Parameters:

comment - The comment to save

notify - Whether the comments should be silent, normal or an announcement (may be null)

groups - The groups the comment should be posted against

Throws:

FailedPrecondition

APIException

save

public boolean save(PSComment comment,
           PSMember editor,
           PSNotify notify,
           List<PSGroup> groups)
             throws FailedPrecondition,
                    APIException

Edits the specified comment in PageSeeder.

Parameters:

comment - The comment to save

editor - The comment's editor (may be different from author)

notify - Whether the comments should be silent, normal or an announcement (may be null)

groups - The groups the comment should be posted against

Throws:

FailedPrecondition

APIException

archiveComment

public boolean archiveComment(PSComment comment,
                     PSMember member)
                       throws FailedPrecondition,
                              APIException

Archives the specified comment in PageSeeder.

Parameters:

comment - The comment to archive

member - The member archiving the comment

Throws:

FailedPrecondition

APIException

unarchiveComment

public boolean unarchiveComment(PSComment comment,
                       PSMember member)
                         throws FailedPrecondition,
                                APIException

Unarchives the specified comment in PageSeeder.

Parameters:

comment - The comment to archive

member - The member archiving the comment

Throws:

FailedPrecondition

APIException

replyToComment

public boolean replyToComment(PSComment comment,
                     PSNotify notify,
                     List<PSGroup> groups,
                     long xlink)
                       throws FailedPrecondition,
                              APIException

Creates the specified comment in PageSeeder.

Parameters:

comment - The comment to archive

notify - Whether the comments should be silent, normal or an announcement (may be null)

groups - The group the comment should be posted against

xlink - The comment to reply to

Throws:

FailedPrecondition

APIException

getComment

public PSComment getComment(long id,
                   PSMember member)
                     throws APIException

Identify a comment from a specific comment ID.

Parameters:

id - The ID of the comment.

member - The member who is trying to access the comment.

Returns:

the matching comment (null if not found)

Throws:

APIException

findComments

public List<PSComment> findComments(PSMember member,
                           PSGroup group,
                           String title,
                           String type,
                           List<String> paths)
                             throws APIException

Find comments using criteria.

Parameters:

member - The member who is trying to access the comments.

group - The context group

title - The comments title (can be null)

type - The comments type (can be null)

paths - A list of paths of URIs the comments must be attached to (can be null)

Returns:

the list of comments found (never null)

Throws:

APIException

findComments

public List<PSComment> findComments(PSMember member,
                           PSGroup group,
                           String title,
                           String type,
                           List<String> statuses,
                           List<String> paths)
                             throws APIException

Find comments using criteria.

Parameters:

member - The member who is trying to access the comments.

group - The context group

title - The comments title (can be null)

type - The comments type (can be null)

statuses - A list of statuses the comments must have (can be null)

paths - A list of paths of URIs the comments must be attached to (can be null)

Returns:

the list of comments found (never null)

Throws:

APIException

getCommentsByFilter

@Deprecated
public List<PSComment> getCommentsByFilter(PSMember member,
                                             PSGroup group,
                                             String title,
                                             String type,
                                             List<String> paths)
                                    throws APIException

Deprecated. Use findComments(PSMember, PSGroup,String, String, List) instead.

Find comments using criteria.

Parameters:

member - The member who is trying to access the comments.

group - The context group

title - The comments title (can be null)

type - The comments type (can be null)

paths - A list of paths of URIs the comments must be attached to (can be null)

Returns:

the list of comments found (never null)

Throws:

APIException

getCommentsByFilter

@Deprecated
public List<PSComment> getCommentsByFilter(PSMember member,
                                             PSGroup group,
                                             String title,
                                             String type,
                                             List<String> statuses,
                                             List<String> paths)
                                    throws APIException

Deprecated. Use findComments(PSMember, PSGroup,String, String, List, List) instead.

Find comments using criteria.

Parameters:

member - The member who is trying to access the comments.

group - The context group

title - The comments title (can be null)

type - The comments type (can be null)

statuses - A list of statuses the comments must have (can be null)

paths - A list of paths of URIs the comments must be attached to (can be null)

Returns:

the list of comments found (never null)

Throws:

APIException

getCache

public static PSEntityCache<PSComment> getCache()

Returns the internal cache used for the comments.

Returns:

the internal cache used for the comments

session

public PSSession session()

Returns:

the session used by the class.