Form.SearchForm (java-kit 1.5.0 API)

java.lang.Object
- io.prismic.Form.SearchForm

Enclosing class:

Form
```
public static class Form.SearchForm
extends Object
```
The object you will use to perform queries. At the moment, only queries of the type "SearchForm" exist in prismic.io's APIs. There is one named "everything", that allow to query through the while repository, and there is also one per collection created by prismic.io administrators in the writing-room. From an Api object, you get a SearchForm form like this: api.getForm("everything"); Then, from a SearchForm form, you query like this: search.query("[[:d = at(document.type, "Product")]]").ref(ref).submit();

Constructor Summary

Constructors
Constructor and Description

SearchForm(Api api, Form form)

Constructors
Constructor and Description
`SearchForm(Api api, Form form)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Form.SearchForm`	`fetch(String... fields)` Restrict the document fragments to the set of fields specified.
`Form.SearchForm`	`fetchLinks(String... fields)` Include the specified fragment in the details of DocumentLink
`Form.SearchForm`	`orderings(String... orderings)` Allows to set which ordering you want for your query.
`Form.SearchForm`	`page(int page)` Allows to set which page you want to get for your query.
`Form.SearchForm`	`page(String page)` Allows to set which page you want to get for your query.
`Form.SearchForm`	`pageSize(int pageSize)` Allows to set the size of the pagination of the query's response.
`Form.SearchForm`	`pageSize(String pageSize)` Allows to set the size of the pagination of the query's response.
`Form.SearchForm`	`query(Predicate... predicates)` Allows to set the query field of the current form, using Predicate objects.
`Form.SearchForm`	`query(String q)` Allows to set the query field of the current form.
`Form.SearchForm`	`ref(Ref ref)` Allows to set the ref on which you wish to be performing the query.
`Form.SearchForm`	`ref(String ref)` Allows to set the ref on which you wish to be performing the query.
`Form.SearchForm`	`set(String field, Integer value)` A simple helper to set numeric value; see set(String,String).
`Form.SearchForm`	`set(String field, String value)` Allows to set one of the form's fields, such as "q" for the query field, or the "ordering" field, or the "pageSize" field.
`Response`	`submit()` The method to call to perform and retrieve your query.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SearchForm
```
public SearchForm(Api api,
                  Form form)
```
- Method Detail
  - set
```
public Form.SearchForm set(String field,
                           String value)
```
    Allows to set one of the form's fields, such as "q" for the query field, or the "ordering" field, or the "pageSize" field. The field must exist in the RESTful description that is in the /api document. To be on the safe side, you should use the specialized methods, and use searchForm.orderings(o) rather than searchForm.set("orderings", o) if they exist.
    
    Parameters:
    
    field - the name of the field to set
    
    value - the value with which to set it
    
    Returns:
    
    the current form, in order to chain those calls
  - set
```
public Form.SearchForm set(String field,
                           Integer value)
```
    A simple helper to set numeric value; see set(String,String).
    
    Parameters:
    
    field - the name of the field to set
    
    value - target value
    
    Returns:
    
    the current form, in order to chain those calls
  - ref
```
public Form.SearchForm ref(Ref ref)
```
    Allows to set the ref on which you wish to be performing the query. This is mandatory to submit a query; if you call api.getForm("everything").submit();, the kit will complain! Please do not forge the ref dynamically in this call, like this: ref(api.getMaster()). Prefer to set a ref variable once for your whole webpage, and use that variable in this method: ref(ref). That way, you can change this variable's assignment once, and trivially set your whole webpage into the future or the past.
    
    Parameters:
    
    ref - the ref object representing the ref on which you wish to query
    
    Returns:
    
    the current form, in order to chain those calls
  - ref
```
public Form.SearchForm ref(String ref)
```
    Allows to set the ref on which you wish to be performing the query. This is mandatory to submit a query; if you call api.getForm("everything").submit();, the kit will complain! Please do not forge the ref dynamically in this call, like this: ref(api.getMaster().getRef()). Prefer to set a ref variable once for your whole webpage, and use that variable in this method: ref(ref). That way, you can change this variable's assignment once, and trivially set your whole webpage into the future or the past.
    
    Parameters:
    
    ref - the ID of the ref on which you wish to query
    
    Returns:
    
    the current form, in order to chain those calls
  - pageSize
```
public Form.SearchForm pageSize(String pageSize)
```
    Allows to set the size of the pagination of the query's response. The default value is 20; a call with a different page size will look like: api.getForm("everything").pageSize("15").ref(ref).submit();.
    
    Parameters:
    
    pageSize - the size of the pagination you wish
    
    Returns:
    
    the current form, in order to chain those calls
  - pageSize
```
public Form.SearchForm pageSize(int pageSize)
```
    Allows to set the size of the pagination of the query's response. The default value is 20; a call with a different page size will look like: api.getForm("everything").pageSize(15).ref(ref).submit();.
    
    Parameters:
    
    pageSize - the size of the pagination you wish
    
    Returns:
    
    the current form, in order to chain those calls
  - page
```
public Form.SearchForm page(String page)
```
    Allows to set which page you want to get for your query. The default value is 1; a call for a different page will look like: api.getForm("everything").page("2").ref(ref).submit(); (do remember that the default size of a page is 20, you can change it with pageSize)
    
    Parameters:
    
    page - the page number
    
    Returns:
    
    the current form, in order to chain those calls
  - fetch
```
public Form.SearchForm fetch(String... fields)
```
    Restrict the document fragments to the set of fields specified.
    
    Parameters:
    
    fields - the fields to return
    
    Returns:
    
    the current form, in order to chain those calls
  - fetchLinks
```
public Form.SearchForm fetchLinks(String... fields)
```
    Include the specified fragment in the details of DocumentLink
    
    Parameters:
    
    fields - the fields to return
    
    Returns:
    
    the current form, in order to chain those calls
  - page
```
public Form.SearchForm page(int page)
```
    Allows to set which page you want to get for your query. The default value is 1; a call for a different page will look like: api.getForm("everything").page(2).ref(ref).submit(); (do remember that the default size of a page is 20, you can change it with pageSize)
    
    Parameters:
    
    page - the page number
    
    Returns:
    
    the current form, in order to chain those calls
  - orderings
```
public Form.SearchForm orderings(String... orderings)
```
    Allows to set which ordering you want for your query. A call will look like: api.getForm("products").orderings("my.product.price desc", "my.product.date").ref(ref).submit(); Read prismic.io's API documentation to learn more about how to write orderings.
    
    Parameters:
    
    orderings - one or more ordering, as the name of a field optionally followed by "desc"
    
    Returns:
    
    the current form, in order to chain those calls
  - query
```
public Form.SearchForm query(String q)
```
    Allows to set the query field of the current form. For instance: search.query("[[:d = at(document.type, "Product")]]"); Look up prismic.io's documentation online to discover the possible query predicates. Beware: a query is a list of predicates, therefore, it always starts with "[[" and ends with "]]".
    
    Parameters:
    
    q - the query to pass
    
    Returns:
    
    the current form, in order to chain those calls
  - query
```
public Form.SearchForm query(Predicate... predicates)
```
    Allows to set the query field of the current form, using Predicate objects. Example: search.query(Predicates.at("document.type", "Product")); See io.prismic.Predicates for more helper methods.
    
    Parameters:
    
    predicates - any number of predicate, is more than one is provided documents that satisfy all predicates will be returned ("AND" query)
    
    Returns:
    
    the current form, in order to chain those calls
  - submit
```
public Response submit()
```
    The method to call to perform and retrieve your query. Please make sure you're set a ref on this SearchForm form before querying, or the kit will complain!
    
    Returns:
    
    the list of documents, that can be directly used as such.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Form.SearchForm

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SearchForm

Method Detail

set

set

ref

ref

pageSize

pageSize

page

fetch

fetchLinks

page

orderings

query

query

submit

toString