Package org.gcube.portal.social.networking.ws.methods.v2

Class FullTextSearch

  • @Path("2/full-text-search")
public class FullTextSearch
extends Object
    REST interface for the social networking library (post and its comments).

    • Constructor Summary

      Constructors 
      Constructor Description
      FullTextSearch()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      javax.ws.rs.core.Response searchByQuery​(javax.servlet.http.HttpServletRequest httpServletRequest, @NotNull(message="query cannot be null") @Size(min=1,message="query cannot be empty") String query, @javax.validation.constraints.Min(value=0L, message="from cannot be negative") int from, @javax.validation.constraints.Min(value=0L, message="quantity cannot be negative") int quantity)
      Retrieve posts/comments that match the given query

    • Constructor Detail

      • FullTextSearch

        public FullTextSearch()

    • Method Detail

      • searchByQuery

        @GET
@Path("search-by-query")
@Produces("application/json")
public javax.ws.rs.core.Response searchByQuery​(@Context
                                               javax.servlet.http.HttpServletRequest httpServletRequest,
                                               @QueryParam("query") @NotNull(message="query cannot be null") @Size(min=1,message="query cannot be empty")
                                               @NotNull(message="query cannot be null") @Size(min=1,message="query cannot be empty") String query,
                                               @DefaultValue("0") @QueryParam("from") @Min(value=0L,message="from cannot be negative")
                                               @javax.validation.constraints.Min(value=0L, message="from cannot be negative") int from,
                                               @DefaultValue("10") @QueryParam("quantity") @Min(value=0L,message="quantity cannot be negative")
                                               @javax.validation.constraints.Min(value=0L, message="quantity cannot be negative") int quantity)
                                        throws javax.validation.ValidationException
        Retrieve posts/comments that match the given query
        Parameters:
        httpServletRequest -
        query - A string to search for
        from - the index of the base result to be returned, range[0, infinity], defaults from = 0
        quantity - defines how many results are most are to be returned, range[1, infinity], defaults from = 0,
        Returns:
        The posts/comments returned belong to the context bound to the AUTH Token
        Throws:
        javax.validation.ValidationException