org.exoplatform.addon.kudos.rest

Class KudosREST

java.lang.Object

org.exoplatform.addon.kudos.rest.KudosREST

All Implemented Interfaces:

org.exoplatform.services.rest.resource.ResourceContainer

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

This class provide a REST endpoint to retrieve detailed information about kudos

Constructor Summary

Constructors

Constructor and Description
KudosREST(KudosService kudosService)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getAllKudosByPeriod(long startDateInSeconds, long endDateInSeconds) Retrieves all kudos by a designed start and end date
javax.ws.rs.core.Response	getAllKudosByPeriodOfDate(long dateInSeconds) Retrieves all kudos by a period of a designed time
javax.ws.rs.core.Response	getEntityKudos(String entityType, String entityId) Retrieves the user settings for kudos
javax.ws.rs.core.Response	getKudos(String identityId) Retrieves the user/space kudos
javax.ws.rs.core.Response	getPeriodDates(String periodType, long dateInSeconds) Retrieves all kudos by a period of a designed time
javax.ws.rs.core.Response	saveKudos(Kudos kudos) Save kudos

Methods inherited from class java.lang.Object

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

Constructor Detail

KudosREST

public KudosREST(KudosService kudosService)

Method Detail

saveKudos

@RolesAllowed(value="users")
public javax.ws.rs.core.Response saveKudos(Kudos kudos)

Save kudos

Parameters:

kudos -

Returns:

getKudos

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

Retrieves the user/space kudos

Returns:

getEntityKudos

@RolesAllowed(value="users")
public javax.ws.rs.core.Response getEntityKudos(String entityType,
                                                                             String entityId)

Retrieves the user settings for kudos

Returns:

getAllKudosByPeriod

@RolesAllowed(value="administrators")
public javax.ws.rs.core.Response getAllKudosByPeriod(long startDateInSeconds,
                                                                                           long endDateInSeconds)

Retrieves all kudos by a designed start and end date

Returns:

getAllKudosByPeriodOfDate

@RolesAllowed(value="administrators")
public javax.ws.rs.core.Response getAllKudosByPeriodOfDate(long dateInSeconds)

Retrieves all kudos by a period of a designed time

Returns:

getPeriodDates

@RolesAllowed(value="users")
public javax.ws.rs.core.Response getPeriodDates(String periodType,
                                                                             long dateInSeconds)

Retrieves all kudos by a period of a designed time

Parameters:

periodType -

dateInSeconds -

Returns: