org.bonitasoft.engine.core.process.comment.api.impl

Class SCommentServiceImpl

java.lang.Object

org.bonitasoft.engine.core.process.comment.api.impl.SCommentServiceImpl

All Implemented Interfaces:

SCommentService

public class SCommentServiceImpl
extends Object
implements SCommentService

Author:

Hongwen Zang, Baptiste Mesta, Matthieu Chaffotte, Celine Souchet

Field Summary

Fields inherited from interface org.bonitasoft.engine.core.process.comment.api.SCommentService

COMMENT, COMMMENT_IS_DELETED

Constructor Summary

Constructors

Constructor and Description
SCommentServiceImpl(Recorder recorder, org.bonitasoft.engine.persistence.ReadPersistenceService persistenceService, ArchiveService archiveService, SessionService sessionService, ReadSessionAccessor sessionAccessor, Map<SystemCommentType,Boolean> systemCommentType, EventService eventService)

Method Summary

Modifier and Type	Method and Description
SComment	addComment(long processInstanceId, String comment) Add a comment on process instance
SComment	addSystemComment(long processInstanceId, String comment) Add a system comment on process instance
void	archive(long archiveDate, SComment sComment)
void	delete(SComment comment) Delete the comment
void	deleteArchivedComments(long processInstanceId) Delete archived comments for a specified process instance
void	deleteComments(long processInstanceId) Delete comments for a specified process instance
SAComment	getArchivedComment(long archivedCommentId)
List<SComment>	getComments(long processInstanceId) Deprecated.
List<SComment>	getComments(long processInstanceId, org.bonitasoft.engine.persistence.QueryOptions queryOptions) Get comments for the given processInstance
long	getNumberOfArchivedComments(org.bonitasoft.engine.persistence.QueryOptions searchOptions) Search number of archived Comments
long	getNumberOfComments(org.bonitasoft.engine.persistence.QueryOptions options) Number of all comments related to the specified query options.
long	getNumberOfCommentsInvolvingUser(long userId, org.bonitasoft.engine.persistence.QueryOptions searchOptions) Search number of all the comments on process instants that the user can access
long	getNumberOfCommentsManagedBy(long managerUserId, org.bonitasoft.engine.persistence.QueryOptions searchOptions) Search number of the comments visible by delegates of managerUserId
long	getNumberOfCommentsSupervisedBy(long supervisorId, org.bonitasoft.engine.persistence.QueryOptions queryOptions) Search number of Comment for a specific supervisor
boolean	isCommentEnabled(SystemCommentType sct) Returning true if the system comments are enabled for the specific SystemCommentType.
List<SAComment>	searchArchivedComments(org.bonitasoft.engine.persistence.QueryOptions searchOptions) Search archived Comments
List<SComment>	searchComments(org.bonitasoft.engine.persistence.QueryOptions options) List all comments related to the specified query options.
List<SComment>	searchCommentsInvolvingUser(long userId, org.bonitasoft.engine.persistence.QueryOptions queryOptions) List all the comments on process instants that the user can access
List<SComment>	searchCommentsManagedBy(long managerUserId, org.bonitasoft.engine.persistence.QueryOptions searchOptions) Search comments visible by delegates of managerUserId
List<SComment>	searchCommentsSupervisedBy(long supervisorId, org.bonitasoft.engine.persistence.QueryOptions queryOptions) Search an Comment for a specific supervisor

Methods inherited from class java.lang.Object

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

Constructor Detail

SCommentServiceImpl

public SCommentServiceImpl(Recorder recorder,
                           org.bonitasoft.engine.persistence.ReadPersistenceService persistenceService,
                           ArchiveService archiveService,
                           SessionService sessionService,
                           ReadSessionAccessor sessionAccessor,
                           Map<SystemCommentType,Boolean> systemCommentType,
                           EventService eventService)

Method Detail

searchComments

public List<SComment> searchComments(org.bonitasoft.engine.persistence.QueryOptions options)
                              throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: SCommentService

List all comments related to the specified query options.

Specified by:

searchComments in interface SCommentService

Parameters:

options - a QueryOptions object, containing some query conditions

Returns:

a list of SComment objects corresponding to the criteria

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

getNumberOfComments

public long getNumberOfComments(org.bonitasoft.engine.persistence.QueryOptions options)
                         throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: SCommentService

Number of all comments related to the specified query options.

Specified by:

getNumberOfComments in interface SCommentService

Parameters:

options - a QueryOptions object, containing some query conditions

Returns:

number of all comments corresponding to the criteria.

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

getComments

@Deprecated
public List<SComment> getComments(long processInstanceId)
                                       throws org.bonitasoft.engine.persistence.SBonitaReadException

Deprecated.

Description copied from interface: SCommentService

Get the first 20 comments for the given processInstance

Specified by:

getComments in interface SCommentService

Parameters:

processInstanceId - identifier of processInstance

Returns:

a list of SComment object

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException - in case of read error

See Also:

QueryOptions#DEFAULT_NUMBER_OF_RESULTS}

getComments

public List<SComment> getComments(long processInstanceId,
                                  org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                           throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: SCommentService

Get comments for the given processInstance

Specified by:

getComments in interface SCommentService

Parameters:

processInstanceId - identifier of processInstance

queryOptions - the query options to filter the results

Returns:

a list of SComment object

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException - in case of read error

addComment

public SComment addComment(long processInstanceId,
                           String comment)
                    throws SCommentAddException

Description copied from interface: SCommentService

Add a comment on process instance

Specified by:

addComment in interface SCommentService

Parameters:

processInstanceId - identifier of processInstance

comment - the comment you want to add

Throws:

SCommentAddException

addSystemComment

public SComment addSystemComment(long processInstanceId,
                                 String comment)
                          throws SCommentAddException

Description copied from interface: SCommentService

Add a system comment on process instance

Specified by:

addSystemComment in interface SCommentService

Parameters:

processInstanceId - identifier of processInstance

comment - the comment you want to add

Throws:

SCommentAddException

delete

public void delete(SComment comment)
            throws SCommentDeletionException

Description copied from interface: SCommentService

Delete the comment

Specified by:

delete in interface SCommentService

Throws:

SCommentDeletionException

deleteComments

public void deleteComments(long processInstanceId)
                    throws org.bonitasoft.engine.commons.exceptions.SBonitaException

Description copied from interface: SCommentService

Delete comments for a specified process instance

Specified by:

deleteComments in interface SCommentService

Throws:

org.bonitasoft.engine.commons.exceptions.SBonitaException

getNumberOfCommentsSupervisedBy

public long getNumberOfCommentsSupervisedBy(long supervisorId,
                                            org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                                     throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: SCommentService

Search number of Comment for a specific supervisor

Specified by:

getNumberOfCommentsSupervisedBy in interface SCommentService

Parameters:

supervisorId - the identifier of supervisor

queryOptions - a map of specific parameters of a query

Returns:

number of Comment for a specific supervisor

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException - if a Read exception occurs

searchCommentsSupervisedBy

public List<SComment> searchCommentsSupervisedBy(long supervisorId,
                                                 org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                                          throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: SCommentService

Search an Comment for a specific supervisor

Specified by:

searchCommentsSupervisedBy in interface SCommentService

Parameters:

supervisorId - the identifier of supervisor

queryOptions - a map of specific parameters of a query

Returns:

an Comment for a specific supervisor

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException - if a Read exception occurs

getNumberOfCommentsInvolvingUser

public long getNumberOfCommentsInvolvingUser(long userId,
                                             org.bonitasoft.engine.persistence.QueryOptions searchOptions)
                                      throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: SCommentService

Search number of all the comments on process instants that the user can access

Specified by:

getNumberOfCommentsInvolvingUser in interface SCommentService

Parameters:

userId - identifier of user

searchOptions - a QueryOptions object, containing some query conditions

Returns:

number of all the comments on process instants that the user can access

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

searchCommentsInvolvingUser

public List<SComment> searchCommentsInvolvingUser(long userId,
                                                  org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                                           throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: SCommentService

List all the comments on process instants that the user can access

Specified by:

searchCommentsInvolvingUser in interface SCommentService

Parameters:

userId - identifier of user

queryOptions - a QueryOptions object, containing some query conditions

Returns:

a list of comments on process instants that the user can access

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

getNumberOfCommentsManagedBy

public long getNumberOfCommentsManagedBy(long managerUserId,
                                         org.bonitasoft.engine.persistence.QueryOptions searchOptions)
                                  throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: SCommentService

Search number of the comments visible by delegates of managerUserId

Specified by:

getNumberOfCommentsManagedBy in interface SCommentService

Parameters:

managerUserId - identifier of a manager user

searchOptions - a QueryOptions object, containing some query conditions

Returns:

number of the comments visible by delegates of managerUserId

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

searchCommentsManagedBy

public List<SComment> searchCommentsManagedBy(long managerUserId,
                                              org.bonitasoft.engine.persistence.QueryOptions searchOptions)
                                       throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: SCommentService

Search comments visible by delegates of managerUserId

Specified by:

searchCommentsManagedBy in interface SCommentService

Parameters:

managerUserId - identifier of a manager user

searchOptions - a QueryOptions object, containing some query conditions

Returns:

a list of comments visible by delegates of managerUserId

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

getNumberOfArchivedComments

public long getNumberOfArchivedComments(org.bonitasoft.engine.persistence.QueryOptions searchOptions)
                                 throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: SCommentService

Search number of archived Comments

Specified by:

getNumberOfArchivedComments in interface SCommentService

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

searchArchivedComments

public List<SAComment> searchArchivedComments(org.bonitasoft.engine.persistence.QueryOptions searchOptions)
                                       throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: SCommentService

Search archived Comments

Specified by:

searchArchivedComments in interface SCommentService

Parameters:

searchOptions - a QueryOptions object, containing some query conditions

Returns:

a list with archived Comments

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

isCommentEnabled

public boolean isCommentEnabled(SystemCommentType sct)

Description copied from interface: SCommentService

Returning true if the system comments are enabled for the specific SystemCommentType.

Specified by:

isCommentEnabled in interface SCommentService

Parameters:

sct - A Enum for system comments

Returns:

Returning true if the system comments are enabled for the specific SystemCommentType.

getArchivedComment

public SAComment getArchivedComment(long archivedCommentId)
                             throws SCommentNotFoundException,
                                    org.bonitasoft.engine.persistence.SBonitaReadException

Specified by:

getArchivedComment in interface SCommentService

Throws:

SCommentNotFoundException

org.bonitasoft.engine.persistence.SBonitaReadException

deleteArchivedComments

public void deleteArchivedComments(long processInstanceId)
                            throws org.bonitasoft.engine.commons.exceptions.SBonitaException

Description copied from interface: SCommentService

Delete archived comments for a specified process instance

Specified by:

deleteArchivedComments in interface SCommentService

Throws:

org.bonitasoft.engine.commons.exceptions.SBonitaException

archive

public void archive(long archiveDate,
                    SComment sComment)
             throws org.bonitasoft.engine.commons.exceptions.SObjectModificationException

Specified by:

archive in interface SCommentService

Throws:

org.bonitasoft.engine.commons.exceptions.SObjectModificationException