Package org.dspace.app.rest.model

Class FilteredItemsQueryRest

java.lang.Object

org.dspace.app.rest.model.FilteredItemsQueryRest

public class FilteredItemsQueryRest
extends Object

REST-based version of structured query contents for the Filtered Items report

Author:

Jean-François Morin (Université Laval)

Constructor Summary

Constructors

Constructor	Description
FilteredItemsQueryRest()

Method Summary

Modifier and Type	Method	Description
List<String>	getAdditionalFields()
List<String>	getCollections()
Set<Filter>	getFilters()
int	getPageLimit()
List<String>	getPredicateFields()
List<QueryOperator>	getPredicateOperators()
List<String>	getPredicateValues()
List<FilteredItemsQueryPredicate>	getQueryPredicates()
static FilteredItemsQueryRest	of(Collection<String> collectionUuids, Collection<FilteredItemsQueryPredicate> predicates, int pageLimit, Collection<Filter> filters, Collection<String> additionalFields)	Shortcut method that builds a FilteredItemsQueryRest instance from its building blocks.
void	setAdditionalFields(List<String> additionalFields)
void	setCollections(List<String> collections)
void	setFilters(Set<Filter> filters)
void	setPageLimit(int pageLimit)
void	setQueryPredicates(List<FilteredItemsQueryPredicate> queryPredicates)
String	toQueryString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FilteredItemsQueryRest

public FilteredItemsQueryRest()

Method Details

of

public static FilteredItemsQueryRest of(Collection<String> collectionUuids,
 Collection<FilteredItemsQueryPredicate> predicates,
 int pageLimit,
 Collection<Filter> filters,
 Collection<String> additionalFields)

Shortcut method that builds a FilteredItemsQueryRest instance from its building blocks.

Parameters:

collectionUuids - collection UUIDs to add

predicates - query predicates used to filter existing items

pageLimit - number of items per page

filters - filters to apply to existing items The filters mapping to true will be applied, others (either missing or mapping to false) will not.

additionalFields - additional fields to display in the resulting report

Returns:

a FilteredItemsQueryRest instance built from the provided parameters

getCollections

public List<String> getCollections()

setCollections

public void setCollections(List<String> collections)

getQueryPredicates

public List<FilteredItemsQueryPredicate> getQueryPredicates()

setQueryPredicates

public void setQueryPredicates(List<FilteredItemsQueryPredicate> queryPredicates)

getPredicateFields

public List<String> getPredicateFields()

getPredicateOperators

public List<QueryOperator> getPredicateOperators()

getPredicateValues

public List<String> getPredicateValues()

getPageLimit

public int getPageLimit()

setPageLimit

public void setPageLimit(int pageLimit)

getFilters

public Set<Filter> getFilters()

setFilters

public void setFilters(Set<Filter> filters)

getAdditionalFields

public List<String> getAdditionalFields()

setAdditionalFields

public void setAdditionalFields(List<String> additionalFields)

toQueryString

public String toQueryString()