org.exoplatform.addons.gamification.rest

Class GamificationRestEndpoint

java.lang.Object

org.exoplatform.addons.gamification.rest.GamificationRestEndpoint

All Implemented Interfaces:

org.exoplatform.services.rest.resource.ResourceContainer

@RolesAllowed(value="users")
public class GamificationRestEndpoint
extends Object
implements org.exoplatform.services.rest.resource.ResourceContainer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GamificationRestEndpoint.GamificationPoints

Constructor Summary

Constructors

Constructor and Description
GamificationRestEndpoint(GamificationService gamificationService, org.exoplatform.social.core.manager.IdentityManager identityManager)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getAllPointsByUserId(String userId) Return all earned points by a user
javax.ws.rs.core.Response	getAllPointsByUserIdAndCurrentMonth(String userId) Return earned points by a user during the current month
javax.ws.rs.core.Response	getAllPointsByUserIdAndCurrentWeek(String userId) Return earned points by a user during the current week
javax.ws.rs.core.Response	getAllPointsByUserIdByDate(String userId, String startDateEntry, String endDateEntry) Return earned points by a user during a given period

Methods inherited from class java.lang.Object

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

Constructor Detail

GamificationRestEndpoint

public GamificationRestEndpoint(GamificationService gamificationService,
                                org.exoplatform.social.core.manager.IdentityManager identityManager)

Method Detail

getAllPointsByUserId

@RolesAllowed(value="users")
public javax.ws.rs.core.Response getAllPointsByUserId(String userId)

Return all earned points by a user

Parameters:

userId - : user social id

Returns:

: and object of type GamificationPoints

getAllPointsByUserIdByDate

@RolesAllowed(value="users")
public javax.ws.rs.core.Response getAllPointsByUserIdByDate(String userId,
                                                                                         String startDateEntry,
                                                                                         String endDateEntry)

Return earned points by a user during a given period

Parameters:

userId - : user social id

startDateEntry - : Date from when gamification api filter earned points

endDateEntry - : Date until when gamification api filter eearned points

Returns:

: and object of type GamificationPoints

getAllPointsByUserIdAndCurrentMonth

@RolesAllowed(value="users")
public javax.ws.rs.core.Response getAllPointsByUserIdAndCurrentMonth(String userId)

Return earned points by a user during the current month

Parameters:

userId - : user social id

Returns:

: and object of type GamificationPoints

getAllPointsByUserIdAndCurrentWeek

@RolesAllowed(value="users")
public javax.ws.rs.core.Response getAllPointsByUserIdAndCurrentWeek(String userId)

Return earned points by a user during the current week

Parameters:

userId - : user social id

Returns:

: : and object of type GamificationPoints