Package io.meeds.gamification.service.impl

Class RealizationServiceImpl

java.lang.Object

io.meeds.gamification.service.impl.RealizationServiceImpl

All Implemented Interfaces:

RealizationService, org.picocontainer.Startable

public class RealizationServiceImpl
extends Object
implements RealizationService, org.picocontainer.Startable

Constructor Summary

Constructors

Constructor

Description

RealizationServiceImpl(ProgramService programService, RuleService ruleService, org.exoplatform.services.resources.ResourceBundleService resourceBundleService, EventService eventService, org.exoplatform.social.core.manager.IdentityManager identityManager, org.exoplatform.social.core.space.spi.SpaceService spaceService, RealizationStorage realizationStorage, org.exoplatform.services.listener.ListenerService listenerService, org.exoplatform.container.xml.InitParams initParams)

Method Summary

Modifier and Type	Method	Description
List<RealizationDTO>	cancelRealizations(String event, String earnerIdentityId, String receiverIdentityId, String objectId, String objectType)	Cancels an existing Realization with an event name for a given object identified by its id and type
long	countParticipantsBetweenDates(Date fromDate, Date toDate)
int	countRealizationsByFilter(RealizationFilter realizationFilter)	Count realizations by filter
int	countRealizationsByFilter(RealizationFilter realizationFilter, org.exoplatform.services.security.Identity userAclIdentity)	Count realizations by filter
List<RealizationDTO>	createRealizations(String event, String eventDetails, String earnerIdentityId, String receiverIdentityId, String objectId, String objectType)	Creates new Realizations switch an event name for a given object identified by its id and type
void	createRealizationsAsync(String event, String eventDetails, String earnerIdentityId, String receiverIdentityId, String objectId, String objectType)	Creates new Realizations asynchronously switch an event name for a given object identified by its id and type
void	createRealizationsAsyncInternal(String event, String eventDetails, String earnerIdentityId, String receiverIdentityId, String objectId, String objectType)
List<RealizationDTO>	deleteRealizations(String objectId, String objectType)	Marks all realizations of a given object, generally due to deletion of originating object
InputStream	exportXlsx(RealizationFilter filter, org.exoplatform.services.security.Identity identity, String fileName, Locale locale)	Export realizations found switch filter into an InputStream containing a file of format XLS
List<RealizationDTO>	findRealizationsByObjectIdAndObjectType(String objectId, String objectType)	Retrieves the list of realizations identified by object Id and object Type.
List<StandardLeaderboard>	getLeaderboard(LeaderboardFilter filter, String currentUser)	Retrieves Leaderboard switch designated filter
int	getLeaderboardRank(long earnerIdentityId, Date fromDate, Date toDate, Long spaceId, Long programId)	Retrieves Leaderboard rank of an earner Identity id and ProgramDTO id for the given date
List<PiechartLeaderboard>	getLeaderboardStatsByIdentityId(String earnerIdentityId, Long spaceId, String period, Date startDate, Date endDate)	Retrieves scores per doamin of a given Identity
List<Long>	getParticipantsBetweenDates(Date fromDate, Date toDate)
RealizationDTO	getRealizationById(long realizationId)	Retrieves a realization identified by its technical identifier.
RealizationDTO	getRealizationById(long realizationId, org.exoplatform.services.security.Identity userAclIdentity)	Retrieves a realization identified by its technical identifier.
List<RealizationDTO>	getRealizationsByFilter(RealizationFilter realizationFilter, int offset, int limit)	Retrieves all Realizations by Filter.
List<RealizationDTO>	getRealizationsByFilter(RealizationFilter realizationFilter, org.exoplatform.services.security.Identity userAclIdentity, int offset, int limit)	Retrieves all Realizations by Filter.
RealizationValidityContext	getRealizationValidityContext(RuleDTO rule, long earnerIdentityId)	Checks whether earner can create a realization on a designated rule at this moment or not
long	getScoreByIdentityId(String earnerIdentityId)	Retrieves Identity total score
long	getScoreByIdentityIdAndBetweenDates(String earnerIdentityId, Date fromDate, Date toDate, Long spaceId, Long programId)	Retrieves identities total score between designated dates
List<ProfileReputation>	getScorePerProgramByIdentityId(String earnerIdentityId)	Compute User reputation score by program
Map<Long,Long>	getScoresByIdentityIdsAndBetweenDates(List<String> earnersId, Date fromDate, Date toDate)	Retrieves identities total score between designated dates
boolean	hasPendingRealization(long ruleId, String earnerIdentityId)	Makes a check whether a given user has a pending realization for a given rule or not.
boolean	isRealizationManager(String username)	Checks whether the user can manage realizations of one or multiple programs, even deleted ones.
void	start()
void	stop()
void	updateRealizationStatus(long realizationId, RealizationStatus status)	Updates an existing realization status
void	updateRealizationStatus(long realizationId, RealizationStatus status, String username)	Updates an existing realization status

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.meeds.gamification.service.RealizationService

getLeaderboardStatsByIdentityId, getScoreByIdentityIdAndBetweenDates

Constructor Details

RealizationServiceImpl

public RealizationServiceImpl(ProgramService programService,
 RuleService ruleService,
 org.exoplatform.services.resources.ResourceBundleService resourceBundleService,
 EventService eventService,
 org.exoplatform.social.core.manager.IdentityManager identityManager,
 org.exoplatform.social.core.space.spi.SpaceService spaceService,
 RealizationStorage realizationStorage,
 org.exoplatform.services.listener.ListenerService listenerService,
 org.exoplatform.container.xml.InitParams initParams)

Method Details

start

public void start()

Specified by:

start in interface org.picocontainer.Startable

stop

public void stop()

Specified by:

stop in interface org.picocontainer.Startable

getRealizationsByFilter

public List<RealizationDTO> getRealizationsByFilter(RealizationFilter realizationFilter,
 org.exoplatform.services.security.Identity userAclIdentity,
 int offset,
 int limit)
                                             throws IllegalAccessException

Description copied from interface: RealizationService

Retrieves all Realizations by Filter.

Specified by:

getRealizationsByFilter in interface RealizationService

Parameters:

realizationFilter - used to filter realizations using RealizationFilter

userAclIdentity - current identity Identity

offset - Offset

limit - Limit

Returns:

A <RealizationDTO> object

Throws:

IllegalAccessException - when User doesn't have enough privileges to access achievements of user

getRealizationsByFilter

public List<RealizationDTO> getRealizationsByFilter(RealizationFilter realizationFilter,
 int offset,
 int limit)

Description copied from interface: RealizationService

Retrieves all Realizations by Filter.

Specified by:

getRealizationsByFilter in interface RealizationService

Parameters:

realizationFilter - used to filter realizations using RealizationFilter

offset - Offset

limit - Limit

Returns:

A <RealizationDTO> object

countRealizationsByFilter

public int countRealizationsByFilter(RealizationFilter realizationFilter,
 org.exoplatform.services.security.Identity userAclIdentity)
                              throws IllegalAccessException

Description copied from interface: RealizationService

Count realizations by filter

Specified by:

countRealizationsByFilter in interface RealizationService

Parameters:

realizationFilter - used to filter realizations using RealizationFilter

userAclIdentity - current Identity

Returns:

realizations count

Throws:

IllegalAccessException - when User doesn't have enough privileges to access achievements of user

countRealizationsByFilter

public int countRealizationsByFilter(RealizationFilter realizationFilter)

Description copied from interface: RealizationService

Count realizations by filter

Specified by:

countRealizationsByFilter in interface RealizationService

Parameters:

realizationFilter - used to filter realizations using RealizationFilter

Returns:

realizations count

getLeaderboardRank

public int getLeaderboardRank(long earnerIdentityId,
 Date fromDate,
 Date toDate,
 Long spaceId,
 Long programId)

Description copied from interface: RealizationService

Retrieves Leaderboard rank of an earner Identity id and ProgramDTO id for the given date

Specified by:

getLeaderboardRank in interface RealizationService

Parameters:

earnerIdentityId - earner Identity id

fromDate - From date

toDate - End Date

spaceId - audience space Id

programId - program Id

Returns:

identity leaderboard rank in Integer

getScoreByIdentityId

public long getScoreByIdentityId(String earnerIdentityId)

Description copied from interface: RealizationService

Retrieves Identity total score

Specified by:

getScoreByIdentityId in interface RealizationService

Parameters:

earnerIdentityId - Identity id

Returns:

total score

getScorePerProgramByIdentityId

public List<ProfileReputation> getScorePerProgramByIdentityId(String earnerIdentityId)

Description copied from interface: RealizationService

Compute User reputation score by program

Specified by:

getScorePerProgramByIdentityId in interface RealizationService

Parameters:

earnerIdentityId - earner Identity id

Returns:

list of objects of type ProfileReputation

createRealizationsAsync

public void createRealizationsAsync(String event,
 String eventDetails,
 String earnerIdentityId,
 String receiverIdentityId,
 String objectId,
 String objectType)

Description copied from interface: RealizationService

Creates new Realizations asynchronously switch an event name for a given object identified by its id and type

Specified by:

createRealizationsAsync in interface RealizationService

Parameters:

event - RuleDTO event name

eventDetails -

earnerIdentityId - Identity id

receiverIdentityId - Identity id

objectId - the designated object type identifier

objectType - an object type, like 'activity', 'kudos' ...

createRealizations

public List<RealizationDTO> createRealizations(String event,
 String eventDetails,
 String earnerIdentityId,
 String receiverIdentityId,
 String objectId,
 String objectType)

Description copied from interface: RealizationService

Creates new Realizations switch an event name for a given object identified by its id and type

Specified by:

createRealizations in interface RealizationService

Parameters:

event - RuleDTO event name

eventDetails -

earnerIdentityId - Identity id

receiverIdentityId - Identity id

objectId - the designated object type identifier

objectType - an object type, like 'activity', 'kudos' ...

Returns:

list of created RealizationDTO

updateRealizationStatus

public void updateRealizationStatus(long realizationId,
 RealizationStatus status)
                             throws org.exoplatform.commons.exception.ObjectNotFoundException

Description copied from interface: RealizationService

Updates an existing realization status

Specified by:

updateRealizationStatus in interface RealizationService

Parameters:

realizationId - RealizationDTO technical identifier

status - new RealizationStatus to set

Throws:

org.exoplatform.commons.exception.ObjectNotFoundException - when the realization identified by its technical identifier is not found

updateRealizationStatus

public void updateRealizationStatus(long realizationId,
 RealizationStatus status,
 String username)
                             throws IllegalAccessException,
org.exoplatform.commons.exception.ObjectNotFoundException

Description copied from interface: RealizationService

Updates an existing realization status

Specified by:

updateRealizationStatus in interface RealizationService

Parameters:

realizationId - RealizationDTO technical identifier

status - new RealizationStatus to set

username - user name of modifier

Throws:

IllegalAccessException - when user is not authorized to update the realization

org.exoplatform.commons.exception.ObjectNotFoundException - when the realization identified by its technical identifier is not found

cancelRealizations

public List<RealizationDTO> cancelRealizations(String event,
 String earnerIdentityId,
 String receiverIdentityId,
 String objectId,
 String objectType)

Description copied from interface: RealizationService

Cancels an existing Realization with an event name for a given object identified by its id and type

Specified by:

cancelRealizations in interface RealizationService

Parameters:

event - RuleDTO event name

earnerIdentityId - Identity id

receiverIdentityId - Identity id

objectId - the designated object type identifier

objectType - an object type, like 'activity', 'kudos' ...

Returns:

list of cancelled RealizationDTO

deleteRealizations

public List<RealizationDTO> deleteRealizations(String objectId,
 String objectType)

Description copied from interface: RealizationService

Marks all realizations of a given object, generally due to deletion of originating object

Specified by:

deleteRealizations in interface RealizationService

Parameters:

objectId - the designated object type identifier

objectType - an object type, like 'activity', 'kudos' ...

Returns:

list of marked as deleted RealizationDTO

getRealizationValidityContext

public RealizationValidityContext getRealizationValidityContext(RuleDTO rule,
 long earnerIdentityId)

Description copied from interface: RealizationService

Checks whether earner can create a realization on a designated rule at this moment or not

Specified by:

getRealizationValidityContext in interface RealizationService

Parameters:

rule - RuleDTO

earnerIdentityId - Identity id

Returns:

RealizationValidityContext if can not create a realization, else null

getLeaderboard

public List<StandardLeaderboard> getLeaderboard(LeaderboardFilter filter,
 String currentUser)
                                         throws IllegalAccessException

Description copied from interface: RealizationService

Retrieves Leaderboard switch designated filter

Specified by:

getLeaderboard in interface RealizationService

Parameters:

filter - of type LeaderboardFilter, used to filter query

currentUser - Currrent user name

Returns:

List of objects of type StandardLeaderboard

Throws:

IllegalAccessException - when space board and anonymous access

getLeaderboardStatsByIdentityId

public List<PiechartLeaderboard> getLeaderboardStatsByIdentityId(String earnerIdentityId,
 Long spaceId,
 String period,
 Date startDate,
 Date endDate)

Description copied from interface: RealizationService

Retrieves scores per doamin of a given Identity

Specified by:

getLeaderboardStatsByIdentityId in interface RealizationService

Parameters:

earnerIdentityId - earner identity id

spaceId - Program Audience Space Identifier

period - Period Type

startDate - Start Date

endDate - End Date

Returns:

a list of object of type PiechartLeaderboard

getScoreByIdentityIdAndBetweenDates

public long getScoreByIdentityIdAndBetweenDates(String earnerIdentityId,
 Date fromDate,
 Date toDate,
 Long spaceId,
 Long programId)

Description copied from interface: RealizationService

Retrieves identities total score between designated dates

Specified by:

getScoreByIdentityIdAndBetweenDates in interface RealizationService

Parameters:

earnerIdentityId - Identity id

fromDate - From date

toDate - End date

spaceId - Space Id

programId - Program Id

Returns:

total score

getScoresByIdentityIdsAndBetweenDates

public Map<Long,Long> getScoresByIdentityIdsAndBetweenDates(List<String> earnersId,
 Date fromDate,
 Date toDate)

Description copied from interface: RealizationService

Retrieves identities total score between designated dates

Specified by:

getScoresByIdentityIdsAndBetweenDates in interface RealizationService

Parameters:

earnersId -

fromDate -

toDate -

Returns:

Map with Identity id as key and score as value

getParticipantsBetweenDates

public List<Long> getParticipantsBetweenDates(Date fromDate,
 Date toDate)

Specified by:

getParticipantsBetweenDates in interface RealizationService

Parameters:

fromDate - start of period

toDate - end of period

Returns:

List of participant users in a period of time

countParticipantsBetweenDates

public long countParticipantsBetweenDates(Date fromDate,
 Date toDate)

Specified by:

countParticipantsBetweenDates in interface RealizationService

Parameters:

fromDate - start of period

toDate - end of period

Returns:

Count participant users in a period of time

getRealizationById

public RealizationDTO getRealizationById(long realizationId)

Description copied from interface: RealizationService

Retrieves a realization identified by its technical identifier.

Specified by:

getRealizationById in interface RealizationService

Parameters:

realizationId - technical identifier of a realization

Returns:

A RealizationDTO object

isRealizationManager

public boolean isRealizationManager(String username)

Description copied from interface: RealizationService

Checks whether the user can manage realizations of one or multiple programs, even deleted ones.

Specified by:

isRealizationManager in interface RealizationService

Parameters:

username - User name

Returns:

true if can manage realizations, else false

getRealizationById

public RealizationDTO getRealizationById(long realizationId,
 org.exoplatform.services.security.Identity userAclIdentity)
                                  throws IllegalAccessException,
org.exoplatform.commons.exception.ObjectNotFoundException

Description copied from interface: RealizationService

Retrieves a realization identified by its technical identifier.

Specified by:

getRealizationById in interface RealizationService

Parameters:

realizationId - technical identifier of a realization

userAclIdentity - current identity Identity

Returns:

A RealizationDTO object

Throws:

IllegalAccessException - when user is not authorized to access realization

org.exoplatform.commons.exception.ObjectNotFoundException - when the realization identified by its technical identifier is not found

findRealizationsByObjectIdAndObjectType

public List<RealizationDTO> findRealizationsByObjectIdAndObjectType(String objectId,
 String objectType)

Description copied from interface: RealizationService

Retrieves the list of realizations identified by object Id and object Type.

Specified by:

findRealizationsByObjectIdAndObjectType in interface RealizationService

Parameters:

objectId - object Id

objectType - object Type

Returns:

A <RealizationDTO> object

hasPendingRealization

public boolean hasPendingRealization(long ruleId,
 String earnerIdentityId)

Description copied from interface: RealizationService

Makes a check whether a given user has a pending realization for a given rule or not.

Specified by:

hasPendingRealization in interface RealizationService

Parameters:

ruleId - RuleDTO identifier

earnerIdentityId - Identity id

Returns:

true if has a pending realization, else false

exportXlsx

public InputStream exportXlsx(RealizationFilter filter,
 org.exoplatform.services.security.Identity identity,
 String fileName,
 Locale locale)
                       throws IllegalAccessException

Description copied from interface: RealizationService

Export realizations found switch filter into an InputStream containing a file of format XLS

Specified by:

exportXlsx in interface RealizationService

Parameters:

filter - used to filter realizations using RealizationFilter

identity - current Identity

fileName - fileName to export

locale - used Locale for XLS header labels

Returns:

InputStream of a file of format XLS

Throws:

IllegalAccessException - when User doesn't have enough privileges to access achievements of user

createRealizationsAsyncInternal

public void createRealizationsAsyncInternal(String event,
 String eventDetails,
 String earnerIdentityId,
 String receiverIdentityId,
 String objectId,
 String objectType)