Package org.alfresco.rest.core.search

Class SearchRequestBuilder

  • All Implemented Interfaces:
    org.alfresco.utility.model.Model
    public class SearchRequestBuilder
extends org.alfresco.rest.search.SearchRequest
    Builder class for creating a search api request

    • Constructor Summary

      Constructors 
      Constructor Description
      SearchRequestBuilder()
      Constructor for Search API Request

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      SearchRequestBuilder setFieldsBuilder​(List<String> fields)
      Set the requested fields for the SearchRequest
      org.alfresco.rest.search.Pagination setPagination​(Integer maxItems, Integer skipCount)
      Set the pagination properties
      SearchRequestBuilder setPagingBuilder​(org.alfresco.rest.search.Pagination paging)
      Set the paging statement for the SearchRequest
      SearchRequestBuilder setQueryBuilder​(org.alfresco.rest.search.RestRequestQueryModel query)
      Set the sql statement for the SearchRequest

      • Methods inherited from class org.alfresco.rest.search.SearchRequest

        addSortClause, getFacetFields, getFacetFormat, getFacetIntervals, getFacetQueries, getFields, getFilterQueries, getHighlight, getInclude, getIncludeRequest, getLanguage, getPaging, getPivots, getQuery, getRanges, getSort, getSpellcheck, getStats, setFacetFields, setFacetFormat, setFacetIntervals, setFacetQueries, setFields, setFilterQueries, setHighlight, setInclude, setIncludeRequest, setLanguage, setPaging, setPivots, setQuery, setRanges, setSpellcheck, setStats

      • Methods inherited from class org.alfresco.utility.model.TestModel

        setRandomValuesForAllFields, toInfo, toJson, toString

    • Constructor Detail

      • SearchRequestBuilder

        public SearchRequestBuilder()
        Constructor for Search API Request

    • Method Detail

      • setQueryBuilder

        public SearchRequestBuilder setQueryBuilder​(org.alfresco.rest.search.RestRequestQueryModel query)
        Set the sql statement for the SearchRequest
        Parameters:
        query - sql statement
        Returns:
        search request

      • setPagingBuilder

        public SearchRequestBuilder setPagingBuilder​(org.alfresco.rest.search.Pagination paging)
        Set the paging statement for the SearchRequest
        Parameters:
        paging - pagination requested
        Returns:
        search request

      • setPagination

        public org.alfresco.rest.search.Pagination setPagination​(Integer maxItems,
                                                         Integer skipCount)
        Set the pagination properties

      • setFieldsBuilder

        public SearchRequestBuilder setFieldsBuilder​(List<String> fields)
        Set the requested fields for the SearchRequest
        Parameters:
        fields - requested fields
        Returns:
        search request