Package org.exoplatform.addons.gamification.service

Interface RealizationsService

All Known Implementing Classes:

RealizationsServiceImpl

public interface RealizationsService

Method Summary

Modifier and Type	Method	Description
int	countRealizationsByFilter(RealizationsFilter filter, org.exoplatform.services.security.Identity identity)	Count realizations by filter
InputStream	exportXlsx(RealizationsFilter 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<GamificationActionsHistoryDTO>	getRealizationsByFilter(RealizationsFilter filter, org.exoplatform.services.security.Identity identity, int offset, int limit)	Retrieves all Realizations by Filter.
GamificationActionsHistoryDTO	updateRealizationStatus(Long gHistoryId, HistoryStatus status, String actionLabel, Long points, String domain)	Retrieves all Realizations by Date.

Method Details

getRealizationsByFilter

List<GamificationActionsHistoryDTO> getRealizationsByFilter(RealizationsFilter filter,
 org.exoplatform.services.security.Identity identity,
 int offset,
 int limit)
                                                     throws IllegalAccessException

Retrieves all Realizations by Filter.

Parameters:

filter - used to filter realizations using RealizationsFilter

identity - current identity Identity

offset - Offset

limit - Limit

Returns:

A <GamificationActionsHistoryDTO> object

Throws:

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

countRealizationsByFilter

int countRealizationsByFilter(RealizationsFilter filter,
 org.exoplatform.services.security.Identity identity)
                       throws IllegalAccessException

Count realizations by filter

Parameters:

filter - used to filter realizations using RealizationsFilter

identity - current Identity

Returns:

realizations count

Throws:

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

exportXlsx

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

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

Parameters:

filter - used to filter realizations using RealizationsFilter

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

updateRealizationStatus

GamificationActionsHistoryDTO updateRealizationStatus(Long gHistoryId,
 HistoryStatus status,
 String actionLabel,
 Long points,
 String domain)
                                               throws org.exoplatform.commons.exception.ObjectNotFoundException

Retrieves all Realizations by Date.

Parameters:

gHistoryId - gHistoryId

status - status

actionLabel -

points -

domain -

Returns:

GamificationActionsHistoryDTO identified by its id when found

Throws:

org.exoplatform.commons.exception.ObjectNotFoundException - GamificationActionsHistory identified by its technical identifier is not found