Package org.ametys.cms.repository

Class ReactionableObjectHelper

java.lang.Object

org.ametys.cms.repository.ReactionableObjectHelper

All Implemented Interfaces:

Component, Serviceable

public final class ReactionableObjectHelper
extends Object
implements Serviceable, Component

Helper class which provides methods to manage reactions on a object

Field Summary

Fields

Modifier and Type	Field	Description
static String	ROLE	The Avalon role

Constructor Summary

Constructors

Constructor	Description
ReactionableObjectHelper()

Method Summary

Modifier and Type	Method	Description
static void	addReaction(ModifiableModelLessDataHolder unversionedDataHolder, UserIdentity user, ReactionableObject.ReactionType reactionType)	Add a user reaction
static List<UserIdentity>	getReactionUsers(ModifiableModelLessDataHolder unversionedDataHolder, ReactionableObject.ReactionType reactionType)	Get the issuers of a reaction
List<Map<String,Object>>	reactionsToJson(ReactionableObject reactionable)	Get the reactions to JSON format
static void	removeReaction(ModifiableModelLessDataHolder unversionedDataHolder, UserIdentity user, ReactionableObject.ReactionType reactionType)	Remove a user reaction
void	saxReactions(ReactionableObject reactionable, ContentHandler contentHandler)	Generates SAX events for the given object's reactions.
void	service(ServiceManager smanager)

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The Avalon role

Constructor Detail

ReactionableObjectHelper

public ReactionableObjectHelper()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

addReaction

public static void addReaction(ModifiableModelLessDataHolder unversionedDataHolder,
                               UserIdentity user,
                               ReactionableObject.ReactionType reactionType)

Add a user reaction

Parameters:

unversionedDataHolder - the unversioned data holder

user - the issuer of reaction

reactionType - the reaction type

removeReaction

public static void removeReaction(ModifiableModelLessDataHolder unversionedDataHolder,
                                  UserIdentity user,
                                  ReactionableObject.ReactionType reactionType)

Remove a user reaction

Parameters:

unversionedDataHolder - the unversioned data holder

user - the issuer of reaction to remove

reactionType - the reaction type

getReactionUsers

public static List<UserIdentity> getReactionUsers(ModifiableModelLessDataHolder unversionedDataHolder,
                                                  ReactionableObject.ReactionType reactionType)

Get the issuers of a reaction

Parameters:

unversionedDataHolder - the unversioned data holder

reactionType - the reaction type

Returns:

the issuers of a reaction as a List

saxReactions

public void saxReactions(ReactionableObject reactionable,
                         ContentHandler contentHandler)
                  throws SAXException

Generates SAX events for the given object's reactions.

Parameters:

reactionable - the ReactionableObject.

contentHandler - the ContentHandler receiving SAX events.

Throws:

SAXException - if an error occurs during the SAX events generation.

reactionsToJson

public List<Map<String,Object>> reactionsToJson(ReactionableObject reactionable)

Get the reactions to JSON format

Parameters:

reactionable - the reactionable object

Returns:

the reactions as JSON