org.exoplatform.kudos.service

Class KudosService

java.lang.Object

org.exoplatform.kudos.service.KudosService

All Implemented Interfaces:

ExoKudosStatisticService, org.picocontainer.Startable

public class KudosService
extends Object
implements ExoKudosStatisticService, org.picocontainer.Startable

A service to manage kudos

Constructor Summary

Constructors

Constructor and Description
KudosService(KudosStorage kudosStorage, org.exoplatform.commons.api.settings.SettingService settingService, org.exoplatform.social.core.space.spi.SpaceService spaceService, org.exoplatform.social.core.manager.IdentityManager identityManager, org.exoplatform.services.listener.ListenerService listenerService, org.exoplatform.container.xml.InitParams params)

Method Summary

Modifier and Type	Method and Description
long	countKudosByPeriodAndReceiver(long identityId, long startDateInSeconds, long endDateInSeconds)
long	countKudosBySenderInCurrentPeriod(String senderId)
String	getAccessPermission()
AccountSettings	getAccountSettings(String username)
List<Kudos>	getAllKudosByEntity(String entityType, String entityId)
List<Kudos>	getAllKudosByEntityTypeInCurrentPeriod(String entityType)
List<Kudos>	getAllKudosByPeriod(long startDateInSeconds, long endDateInSeconds)
List<Kudos>	getAllKudosByPeriodOfDate(long dateInSeconds)
List<Kudos>	getAllKudosBySenderInCurrentPeriod(String identityId)
GlobalSettings	getGlobalSettings()
List<Kudos>	getKudosByPeriodAndReceiver(long identityId, long startDateInSeconds, long endDateInSeconds)
List<Kudos>	getKudosByReceiverInCurrentPeriod(String receiverType, String receiverId)
long	getKudosPerPeriod()
Map<String,Object>	getStatisticParameters(String operation, Object result, Object... methodArgs) Retrieve statistic log parameters
boolean	isAuthorized(String username) Check if user is authorized to send/receive Kudos
void	saveGlobalSettings(GlobalSettings settings)
void	saveKudosActivity(long kudosId, long activityId)
Kudos	sendKudos(Kudos kudos, String senderId)
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

KudosService

public KudosService(KudosStorage kudosStorage,
                    org.exoplatform.commons.api.settings.SettingService settingService,
                    org.exoplatform.social.core.space.spi.SpaceService spaceService,
                    org.exoplatform.social.core.manager.IdentityManager identityManager,
                    org.exoplatform.services.listener.ListenerService listenerService,
                    org.exoplatform.container.xml.InitParams params)

Method Detail

start

public void start()

Specified by:

start in interface org.picocontainer.Startable

stop

public void stop()

Specified by:

stop in interface org.picocontainer.Startable

getAccountSettings

public AccountSettings getAccountSettings(String username)

Parameters:

username - username to get its settings

Returns:

kudos settings of a user

saveKudosActivity

public void saveKudosActivity(long kudosId,
                              long activityId)
                       throws Exception

Throws:

Exception

sendKudos

public Kudos sendKudos(Kudos kudos,
                       String senderId)
                throws Exception

Throws:

Exception

getAllKudosByPeriod

public List<Kudos> getAllKudosByPeriod(long startDateInSeconds,
                                       long endDateInSeconds)

getAllKudosByPeriodOfDate

public List<Kudos> getAllKudosByPeriodOfDate(long dateInSeconds)

getAllKudosByEntity

public List<Kudos> getAllKudosByEntity(String entityType,
                                       String entityId)

getAllKudosByEntityTypeInCurrentPeriod

public List<Kudos> getAllKudosByEntityTypeInCurrentPeriod(String entityType)

getAllKudosBySenderInCurrentPeriod

public List<Kudos> getAllKudosBySenderInCurrentPeriod(String identityId)

countKudosByPeriodAndReceiver

public long countKudosByPeriodAndReceiver(long identityId,
                                          long startDateInSeconds,
                                          long endDateInSeconds)

getKudosByPeriodAndReceiver

public List<Kudos> getKudosByPeriodAndReceiver(long identityId,
                                               long startDateInSeconds,
                                               long endDateInSeconds)

getKudosByReceiverInCurrentPeriod

public List<Kudos> getKudosByReceiverInCurrentPeriod(String receiverType,
                                                     String receiverId)

countKudosBySenderInCurrentPeriod

public long countKudosBySenderInCurrentPeriod(String senderId)

saveGlobalSettings

public void saveGlobalSettings(GlobalSettings settings)

getGlobalSettings

public GlobalSettings getGlobalSettings()

getKudosPerPeriod

public long getKudosPerPeriod()

getAccessPermission

public String getAccessPermission()

isAuthorized

public boolean isAuthorized(String username)

Check if user is authorized to send/receive Kudos

Parameters:

username - username to check

Returns:

true if authorised else return false

getStatisticParameters

public Map<String,Object> getStatisticParameters(String operation,
                                                 Object result,
                                                 Object... methodArgs)

Description copied from interface: ExoKudosStatisticService

Retrieve statistic log parameters

Specified by:

getStatisticParameters in interface ExoKudosStatisticService

Returns:

a Map of parameters to include in statistic log