Package | Description |
---|---|
com.fatwire.assetapi.data | |
com.fatwire.assetapi.data.search |
Contains all interfaces and classes required for use and extension of the Searcher API.
|
Modifier and Type | Method and Description |
---|---|
Searcher |
DefaultBuildersFactory.newSearcher() |
Searcher |
BuildersFactory.newSearcher()
Returns a
Searcher which can be further built upon for creating a search query. |
protected Searcher |
BaseController.newSearcher()
Returns a new
Searcher which can be further built upon for creating a search query. |
Modifier and Type | Method and Description |
---|---|
Searcher |
Searcher.filter(Filter filter)
Sets a filter condition in the query built by this builder.
|
Searcher |
Searcher.from(String type, String... subtypes)
Sets the type and subtypes to search assets against.
|
Searcher |
Searcher.inSite(String site)
Sets the site to search assets from.
|
static Searcher |
SearchHelper.newFieldSearcher(String select)
Returns a searcher instance with only the selection fields set.
|
static Searcher |
SearchHelper.newFieldSearcher(String select, Filter where)
Returns a searcher instance with only the selection fields and a filter set.
|
static Searcher |
SearchHelper.newFieldSearcher(String select, Filter where, Orders orderBy)
Returns a searcher instance with only the selection fields, a filter and sort orders set.
|
static Searcher |
SearchHelper.newFieldSearcher(String select, Orders orderBy)
Returns a searcher instance with only the selection fields and sort orders set.
|
static Searcher |
SearchHelper.newFieldSearcherForType(String select, String from)
Returns a searcher instance with only the selection fields and the asset type set.
|
static Searcher |
SearchHelper.newFieldSearcherForType(String select, String from, Filter where)
Returns a searcher instance with only the selection fields, the asset type and a filter set.
|
static Searcher |
SearchHelper.newFieldSearcherForType(String select, String from, Filter where, Orders orderBy)
Returns a searcher instance with only the selection fields, the asset type, a filter and sort orders set.
|
static Searcher |
SearchHelper.newFieldSearcherForType(String select, String from, Orders orderBy)
Returns a searcher instance with only the selection fields, the asset type and sort orders set.
|
static Searcher |
SearchHelper.newFieldSearcherForTypeInSite(String select, String from, String in)
Returns a searcher instance with only the selection fields, the asset type and the site name set.
|
static Searcher |
SearchHelper.newFieldSearcherForTypeInSite(String select, String from, String in, Filter where)
Returns a searcher instance with only the selection fields, the asset type, the site name and a filter set.
|
static Searcher |
SearchHelper.newFieldSearcherForTypeInSite(String select, String from, String in, Filter where, Orders orderBy)
Returns a searcher instance with the selection fields, the asset type, the site name, a filter and sort orders set.
|
static Searcher |
SearchHelper.newFieldSearcherForTypeInSite(String select, String from, String in, Orders orderBy)
Returns a searcher instance with only the selection fields, the asset type, the site name and sort orders set.
|
static Searcher |
SearchHelper.newFieldSearcherInSite(String select, String in)
Returns a searcher instance with only the selection fields and the site name set.
|
static Searcher |
SearchHelper.newFieldSearcherInSite(String select, String in, Filter where)
Returns a searcher instance with only the selection fields, the site name and a filter set.
|
static Searcher |
SearchHelper.newFieldSearcherInSite(String select, String in, Filter where, Orders orderBy)
Returns a searcher instance with only the selection fields, the site name, a filter and sort orders set.
|
static Searcher |
SearchHelper.newFieldSearcherInSite(String select, String in, Orders orderBy)
Returns a searcher instance with only the selection fields, the site name and sort orders set.
|
static Searcher |
SearchHelper.newSearcher()
Returns a searcher instance without any clauses set.
|
static Searcher |
SearchHelper.newSearcher(Filter where)
Returns a searcher instance with only a filter set.
|
static Searcher |
SearchHelper.newSearcher(Filter where, Orders orderBy)
Returns a searcher instance with only a filter and sort orders set.
|
static Searcher |
SearchHelper.newSearcher(Orders orderBy)
Returns a searcher instance with only sort orders set.
|
static Searcher |
SearchHelper.newSearcherForType(String from, Filter where)
Returns a searcher instance with only the asset type and a filter set.
|
static Searcher |
SearchHelper.newSearcherForType(String from, Filter where, Orders orderBy)
Returns a searcher instance with only the asset type, a filter and sort orders set.
|
static Searcher |
SearchHelper.newSearcherForType(String from, Orders orderBy)
Returns a searcher instance with only the asset type and sort orders set.
|
static Searcher |
SearchHelper.newSearcherForType(String assetType, String... subtypes)
Returns a searcher instance with only the asset type set.
|
static Searcher |
SearchHelper.newSearcherForTypeInSite(String from, String in)
Returns a searcher instance with only the asset type and the site name set.
|
static Searcher |
SearchHelper.newSearcherForTypeInSite(String from, String in, Filter where)
Returns a searcher instance with only the asset type, the site name and a filter set.
|
static Searcher |
SearchHelper.newSearcherForTypeInSite(String from, String in, Filter where, Orders orderBy)
Returns a searcher instance with only the asset type, the site name, a filter and sort orders set.
|
static Searcher |
SearchHelper.newSearcherForTypeInSite(String from, String in, Orders orderBy)
Returns a searcher instance with only the asset type, the site name and sort orders set.
|
static Searcher |
SearchHelper.newSearcherInSite(String in)
Returns a searcher instance with only the site name set.
|
static Searcher |
SearchHelper.newSearcherInSite(String in, Filter where)
Returns a searcher instance with only the site name and a filter set.
|
static Searcher |
SearchHelper.newSearcherInSite(String in, Filter where, Orders orderBy)
Returns a searcher instance with only he site name, a filter and sort orders set.
|
static Searcher |
SearchHelper.newSearcherInSite(String in, Orders orderBy)
Returns a searcher instance with only the site name and sort orders set.
|
Searcher |
Searcher.orderBy(Orders order)
Sets a ordering sequence for the results.
|
Searcher |
Searcher.select(String fields, String... moreFields)
Sets the fields to select from results returned by search using the query built by this builder.
|
Searcher |
Searcher.selectAll()
Flags that all fields in the results should be returned by the search invoked by this builder.
|
Searcher |
Searcher.startAt(int index)
Sets the start index for the results page.
|
Searcher |
Searcher.top(int pageSize)
Sets the number of results to return.
|