Package org.opencastproject.list.api

Class DefaultResourceListQuery

java.lang.Object

org.opencastproject.list.api.DefaultResourceListQuery

All Implemented Interfaces:

ResourceListQuery

Direct Known Subclasses:

AclsListQuery, AgentsListQuery, EventListQuery, GroupsListQuery, JobsListQuery, SeriesListQuery, ServersListQuery, ServicesListQuery, ThemesListQuery, UsersListQuery

public class DefaultResourceListQuery
extends Object
implements ResourceListQuery

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<ResourceListFilter<?>>	availableFilters
protected Optional<String>	sortBy

Constructor Summary

Constructors

Constructor	Description
DefaultResourceListQuery()

Method Summary

Modifier and Type	Method	Description
void	addFilter(ResourceListFilter<?> filter)
List<ResourceListFilter<?>>	getAvailableFilters()	Returns all the available ResourceListFilter filters with this query.
ResourceListFilter<?>	getFilter(String name)	Returns the filter with the given name
List<ResourceListFilter<?>>	getFilters()	Returns all the ResourceListFilter set for the query.
<A> Optional<A>	getFilterValue(String name)	Returns the filter value wrapped in an Optional or none if the filter is not existing or has no value.
Optional<Integer>	getLimit()	Returns the limit for the resource query
Optional<Integer>	getOffset()	Returns the offset for the resource query
Optional<String>	getSortBy()	Returns the name of the field by which the list should be sorted
Boolean	hasFilter(String name)	Returns if the given filter is or not set
void	removeFilter(ResourceListFilter<?> filter)
void	setLimit(Integer limit)
void	setOffset(Integer offset)

Methods inherited from class java.lang.Object

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

Field Details

availableFilters

protected final List<ResourceListFilter<?>> availableFilters

sortBy

protected Optional<String> sortBy

Constructor Details

DefaultResourceListQuery

public DefaultResourceListQuery()

Method Details

addFilter

public void addFilter(ResourceListFilter<?> filter)

removeFilter

public void removeFilter(ResourceListFilter<?> filter)

setLimit

public void setLimit(Integer limit)

setOffset

public void setOffset(Integer offset)

getFilters

public List<ResourceListFilter<?>> getFilters()

Description copied from interface: ResourceListQuery

Returns all the ResourceListFilter set for the query.

Specified by:

getFilters in interface ResourceListQuery

Returns:

all the query filters

getFilter

public ResourceListFilter<?> getFilter(String name)

Description copied from interface: ResourceListQuery

Returns the filter with the given name

Specified by:

getFilter in interface ResourceListQuery

Parameters:

name -

Returns:

the query filter or null if the filter does not exist

getLimit

public Optional<Integer> getLimit()

Description copied from interface: ResourceListQuery

Returns the limit for the resource query

Specified by:

getLimit in interface ResourceListQuery

Returns:

the list limit

getOffset

public Optional<Integer> getOffset()

Description copied from interface: ResourceListQuery

Returns the offset for the resource query

Specified by:

getOffset in interface ResourceListQuery

Returns:

the list offset

getSortBy

public Optional<String> getSortBy()

Description copied from interface: ResourceListQuery

Returns the name of the field by which the list should be sorted

Specified by:

getSortBy in interface ResourceListQuery

Returns:

the name of the field to use to sort the list

hasFilter

public Boolean hasFilter(String name)

Description copied from interface: ResourceListQuery

Returns if the given filter is or not set

Specified by:

hasFilter in interface ResourceListQuery

Parameters:

name - the filter name

Returns:

true if set

getAvailableFilters

public List<ResourceListFilter<?>> getAvailableFilters()

Description copied from interface: ResourceListQuery

Returns all the available ResourceListFilter filters with this query. The objects returned in the list are simple instance without any filter value set.

Specified by:

getAvailableFilters in interface ResourceListQuery

Returns:

all the available filters

getFilterValue

public <A> Optional<A> getFilterValue(String name)

Returns the filter value wrapped in an Optional or none if the filter is not existing or has no value.

Parameters:

name - the filter name

Returns:

an Optional wrapping the value or none.