Package org.opencastproject.event.comment.persistence

Class EventCommentDatabaseServiceImpl

java.lang.Object

org.opencastproject.opensearch.index.rebuild.AbstractIndexProducer

org.opencastproject.event.comment.persistence.EventCommentDatabaseServiceImpl

All Implemented Interfaces:

EventCommentDatabaseService, IndexProducer

public class EventCommentDatabaseServiceImpl
extends AbstractIndexProducer
implements EventCommentDatabaseService

Implements permanent storage for event comments.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PERSISTENCE_UNIT

Constructor Summary

Constructors

Constructor	Description
EventCommentDatabaseServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	OSGi component activation callback
int	countComments()
void	deleteComment(long commentId)	Delete a comment from an event.
void	deleteComments(String eventId)	Delete all comments from an event.
EventComment	getComment(long commentId)	Get a comment for a particular event.
Iterator<EventCommentDto>	getComments()
List<EventComment>	getComments(String eventId)	Get all of the comments for an event.
Map<String,List<String>>	getEventsWithComments()	Return all known event ID's with existing comments, grouped by organization ID
List<String>	getReasons()	Get the available reasons for commenting on an event.
IndexRebuildService.Service	getService()	Get the service that implements IndexProducer.
void	repopulate(IndexRebuildService.DataType type)	Re-add the data of this service to the index.
void	setDBSessionFactory(DBSessionFactory dbSessionFactory)
void	setEntityManagerFactory(javax.persistence.EntityManagerFactory emf)	OSGi DI
void	setIndex(OpenSearchIndex index)	OSgi callback for the OpenSearch index.
void	setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectoryService)	OSGi callback to set the organization directory service.
void	setSecurityService(SecurityService securityService)	OSGi callback to set the security context to run with.
void	setUserDirectoryService(UserDirectoryService userDirectoryService)	OSGi callback to set the user directory service.
EventComment	updateComment(EventComment comment)	Update a comment.

Methods inherited from class org.opencastproject.opensearch.index.rebuild.AbstractIndexProducer

logIndexRebuildBegin, logIndexRebuildBegin, logIndexRebuildError, logIndexRebuildError, logIndexRebuildError, logIndexRebuildProgress, logIndexRebuildProgress, logIndexRebuildProgress, logIndexRebuildProgress, logSkippingElement, logSkippingElement

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opencastproject.opensearch.index.rebuild.IndexProducer

clear, dataTypeSupported, getSupportedDataTypes

Field Details

PERSISTENCE_UNIT

public static final String PERSISTENCE_UNIT

See Also:

• Constant Field Values

Constructor Details

EventCommentDatabaseServiceImpl

public EventCommentDatabaseServiceImpl()

Method Details

activate

public void activate(org.osgi.service.component.ComponentContext cc)

OSGi component activation callback

setEntityManagerFactory

public void setEntityManagerFactory(javax.persistence.EntityManagerFactory emf)

OSGi DI

setDBSessionFactory

public void setDBSessionFactory(DBSessionFactory dbSessionFactory)

setSecurityService

public void setSecurityService(SecurityService securityService)

OSGi callback to set the security context to run with.

Parameters:

securityService - The security service

setUserDirectoryService

public void setUserDirectoryService(UserDirectoryService userDirectoryService)

OSGi callback to set the user directory service.

Parameters:

userDirectoryService - the user directory service

setOrganizationDirectoryService

public void setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectoryService)

OSGi callback to set the organization directory service.

Parameters:

organizationDirectoryService - the organization directory service

setIndex

public void setIndex(OpenSearchIndex index)

OSgi callback for the OpenSearch index.

Parameters:

index - the OpenSearch index.

getReasons

public List<String> getReasons()
                        throws EventCommentDatabaseException

Description copied from interface: EventCommentDatabaseService

Get the available reasons for commenting on an event.

Specified by:

getReasons in interface EventCommentDatabaseService

Returns:

A list of reasons of why a comment was made.

Throws:

EventCommentDatabaseException - Thrown if there was an issue getting the comment reasons.

getComment

public EventComment getComment(long commentId)
                        throws NotFoundException,
EventCommentDatabaseException

Description copied from interface: EventCommentDatabaseService

Get a comment for a particular event.

Specified by:

getComment in interface EventCommentDatabaseService

Parameters:

commentId - The id for the comment.

Returns:

The comment

Throws:

NotFoundException - Thrown if the comment cannot be found.

EventCommentDatabaseException - Thrown if there was an issue getting the comment from the database.

deleteComment

public void deleteComment(long commentId)
                   throws NotFoundException,
EventCommentDatabaseException

Description copied from interface: EventCommentDatabaseService

Delete a comment from an event.

Specified by:

deleteComment in interface EventCommentDatabaseService

Parameters:

commentId - The id of the comment.

Throws:

NotFoundException - Thrown if cannot find the event / comment.

EventCommentDatabaseException - Thrown if there is a problem deleting the comment.

deleteComments

public void deleteComments(String eventId)
                    throws NotFoundException,
EventCommentDatabaseException

Description copied from interface: EventCommentDatabaseService

Delete all comments from an event.

Specified by:

deleteComments in interface EventCommentDatabaseService

Parameters:

eventId - The id of the event.

Throws:

NotFoundException - Thrown if cannot find the event.

EventCommentDatabaseException - Thrown if there is a problem deleting the comments.

updateComment

public EventComment updateComment(EventComment comment)
                           throws EventCommentDatabaseException

Description copied from interface: EventCommentDatabaseService

Update a comment.

Specified by:

updateComment in interface EventCommentDatabaseService

Parameters:

comment - The new comment status to update to.

Returns:

The comment updated.

Throws:

EventCommentDatabaseException - Thrown if there is a problem updating the comment.

getComments

public List<EventComment> getComments(String eventId)
                               throws EventCommentDatabaseException

Description copied from interface: EventCommentDatabaseService

Get all of the comments for an event.

Specified by:

getComments in interface EventCommentDatabaseService

Parameters:

eventId - The id of the event to get the comments for (mediapackage id).

Returns:

The List of comments.

Throws:

EventCommentDatabaseException - Thrown if there was a problem getting the comments from the database.

getComments

public Iterator<EventCommentDto> getComments()
                                      throws EventCommentDatabaseException

Throws:

EventCommentDatabaseException

countComments

public int countComments()
                  throws EventCommentDatabaseException

Throws:

EventCommentDatabaseException

getEventsWithComments

public Map<String,List<String>> getEventsWithComments()

Return all known event ID's with existing comments, grouped by organization ID

Returns:

a list of all event ID's grouped by organization ID

repopulate

public void repopulate(IndexRebuildService.DataType type)
                throws IndexRebuildException

Description copied from interface: IndexProducer

Re-add the data of this service to the index.

Specified by:

repopulate in interface IndexProducer

Parameters:

type - Limit the data added to the index. Use ALL to re-index all data.

Throws:

IndexRebuildException

getService

public IndexRebuildService.Service getService()

Description copied from interface: IndexProducer

Get the service that implements IndexProducer.

Specified by:

getService in interface IndexProducer

Returns:

service The service that implements IndexProducer.