Package org.opencastproject.list.common.query

Class PlaylistsListQuery

java.lang.Object

org.opencastproject.list.api.DefaultResourceListQuery

org.opencastproject.list.common.query.PlaylistsListQuery

All Implemented Interfaces:

ResourceListQuery

public class PlaylistsListQuery
extends DefaultResourceListQuery

Query for the playlists list. The following filters can be used:

• textFilter (free text search across title, description, creator)
• creator
• updated (date period)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FILTER_CREATOR_NAME
static final String	FILTER_TEXT_NAME
static final String	FILTER_UPDATED_NAME

Fields inherited from class org.opencastproject.list.api.DefaultResourceListQuery

availableFilters, sortBy

Constructor Summary

Constructors

Constructor	Description
PlaylistsListQuery()

Method Summary

Modifier and Type	Method	Description
static ResourceListFilter<String>	createCreatorFilter(Optional<String> creator)	Create a new ResourceListFilter based on a creator
static ResourceListFilter<String>	createTextFilter(Optional<String> value)	Create a new ResourceListFilter based on a free text
static ResourceListFilter<Tuple<Date,Date>>	createUpdatedFilter(Optional<Tuple<Date,Date>> period)	Create a new ResourceListFilter based on an updated date period
Optional<String>	getCreator()
Optional<String>	getTextFilter()
Optional<Tuple<Date,Date>>	getUpdated()
void	withCreator(String creator)
void	withTextFilter(String text)
void	withUpdated(Tuple<Date,Date> period)

Methods inherited from class org.opencastproject.list.api.DefaultResourceListQuery

addFilter, getAvailableFilters, getFilter, getFilters, getFilterValue, getLimit, getOffset, getSortBy, hasFilter, removeFilter, setLimit, setOffset

Methods inherited from class java.lang.Object

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

Field Details

FILTER_TEXT_NAME

public static final String FILTER_TEXT_NAME

See Also:

• Constant Field Values

FILTER_CREATOR_NAME

public static final String FILTER_CREATOR_NAME

See Also:

• Constant Field Values

FILTER_UPDATED_NAME

public static final String FILTER_UPDATED_NAME

See Also:

• Constant Field Values

Constructor Details

PlaylistsListQuery

public PlaylistsListQuery()

Method Details

withTextFilter

public void withTextFilter(String text)

getTextFilter

public Optional<String> getTextFilter()

withCreator

public void withCreator(String creator)

getCreator

public Optional<String> getCreator()

withUpdated

public void withUpdated(Tuple<Date,Date> period)

getUpdated

public Optional<Tuple<Date,Date>> getUpdated()

createTextFilter

public static ResourceListFilter<String> createTextFilter(Optional<String> value)

Create a new ResourceListFilter based on a free text

Parameters:

value - the free text to filter with or none

Returns:

a new ResourceListFilter for a free text

createCreatorFilter

public static ResourceListFilter<String> createCreatorFilter(Optional<String> creator)

Create a new ResourceListFilter based on a creator

Parameters:

creator - the creator to filter with or none

Returns:

a new ResourceListFilter for a creator

createUpdatedFilter

public static ResourceListFilter<Tuple<Date,Date>> createUpdatedFilter(Optional<Tuple<Date,Date>> period)

Create a new ResourceListFilter based on an updated date period

Parameters:

period - the updated date period as Tuple with two Date or none

Returns:

a new ResourceListFilter for an updated date period