org.cyclos.services.users

Interface GeneralReferenceService

All Superinterfaces:

CRUDService<GeneralReferenceDTO,GeneralReferenceData,GeneralReferenceDataParams>, Service

public interface GeneralReferenceService
extends CRUDService<GeneralReferenceDTO,GeneralReferenceData,GeneralReferenceDataParams>

Service for general references, in which users can set references to other users directly

Author:

fvidal

Method Summary

Modifier and Type	Method and Description
GeneralReferenceSearchData	getSearchData(@NotNull UserLocatorVO user) Returns data used for search general references over the given user
ReferenceStatisticsVO	getStatistics(@NotNull ReferenceStatisticsParams params) Returns reference statistics for the given user.
Page<GeneralReferenceEntryVO>	search(@NotNull GeneralReferenceQuery query) Searches for references for a given owner, according to the specified query parameters

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Method Detail

getSearchData

GeneralReferenceSearchData getSearchData(@NotNull
                                         @NotNull UserLocatorVO user)
                                  throws FrameworkException

Returns data used for search general references over the given user

Throws:

FrameworkException

getStatistics

ReferenceStatisticsVO getStatistics(@NotNull
                                    @NotNull ReferenceStatisticsParams params)
                             throws FrameworkException

Returns reference statistics for the given user. The params allows periods. The order of the resulting periods is the same as the order of the input periods. If no periods are specified, 3 statistics are returned: all time and last 30 days. The maximum allowed number of periods is 5.

Throws:

FrameworkException

search

Page<GeneralReferenceEntryVO> search(@NotNull
                                     @NotNull GeneralReferenceQuery query)
                              throws FrameworkException

Searches for references for a given owner, according to the specified query parameters

Throws:

FrameworkException