Package org.opencastproject.list.common.query

Class EventListQuery

java.lang.Object

org.opencastproject.list.api.DefaultResourceListQuery

org.opencastproject.list.common.query.EventListQuery

All Implemented Interfaces:

ResourceListQuery

public class EventListQuery
extends DefaultResourceListQuery

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

• series
• presenters
• presenter's usernames
• contributors
• location
• agent
• language
• startDate
• status

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FILTER_AGENT_NAME
static final String	FILTER_COMMENTS_NAME
static final String	FILTER_CONTRIBUTORS_NAME
static final String	FILTER_IS_PUBLISHED_LABEL
static final String	FILTER_IS_PUBLISHED_NAME
static final String	FILTER_LANGUAGE_NAME
static final String	FILTER_LOCATION_NAME
static final String	FILTER_PRESENTERS_BIBLIOGRAPHIC_NAME
static final String	FILTER_PRESENTERS_TECHNICAL_NAME
static final String	FILTER_PUBLISHER_NAME
static final String	FILTER_READ_ACCESS_LABEL
static final String	FILTER_READ_ACCESS_NAME
static final String	FILTER_SERIES_NAME
static final String	FILTER_STARTDATE_NAME
static final String	FILTER_STATUS_NAME
static final String	FILTER_TEXT_NAME
static final String	FILTER_WRITE_ACCESS_LABEL
static final String	FILTER_WRITE_ACCESS_NAME

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

availableFilters, sortBy

Constructor Summary

Constructors

Constructor	Description
EventListQuery()

Method Summary

Modifier and Type	Method	Description
static ResourceListFilter<String>	createAgentFilter(Optional<String> agent)	Create a new ResourceListFilter based on an agent
static ResourceListFilter<String>	createCommentsFilter(Optional<String> comments)	Create a new ResourceListFilter based on comments
static ResourceListFilter<String>	createContributorsFilter(Optional<String> contributor)	Create a new ResourceListFilter based on a contributor
static ResourceListFilter<String>	createIsPublishedFilter(Optional<String> isPublished)	Create a new ResourceListFilter based on is published
static ResourceListFilter<String>	createLanguageFilter(Optional<String> language)	Create a new ResourceListFilter based on a language
static ResourceListFilter<String>	createLocationFilter(Optional<String> location)	Create a new ResourceListFilter based on a location
static ResourceListFilter<String>	createPresentersFilter(Optional<String> presenter)	Create a new ResourceListFilter based on a presenter's full name
static ResourceListFilter<String>	createPublisherFilter(Optional<String> publisher)	Create a new ResourceListFilter based on publishers
static ResourceListFilter<String>	createReadAccessFilter(Optional<String> readAccess)	Create a new ResourceListFilter based on a read role
static ResourceListFilter<String>	createSeriesFilter(Optional<String> seriesId)	Create a new ResourceListFilter based on the Series id
static ResourceListFilter<Tuple<Date,Date>>	createStartDateFilter(Optional<Tuple<Date,Date>> period)	Create a new ResourceListFilter based on start date period
static ResourceListFilter<String>	createStatusFilter(Optional<String> status)	Create a new ResourceListFilter based on stats
static ResourceListFilter<String>	createTechnicalPresentersFilter(Optional<String> presenter)	Create a new ResourceListFilter based on a presenter's user name
static ResourceListFilter<String>	createWriteAccessFilter(Optional<String> writeAccess)	Create a new ResourceListFilter based on a write role
Optional<String>	getAgent()	Returns an Optional containing the agent used to filter if set
Optional<String>	getComments()	Returns an Optional containing the comments used to filter if set
Optional<String>	getContributor()	Returns an Optional containing the contributor used to filter if set
Optional<String>	getLanguage()	Returns an Optional containing the language used to filter if set
Optional<String>	getLocation()	Returns an Optional containing the location used to filter if set
Optional<String>	getPresenter()	Returns an Optional containing the presenter used to filter if set
Optional<String>	getPublisher()	Returns an Optional containing the publisher used to filter if set
Optional<String>	getSeriesId()	Returns an Optional containing the seriesId used to filter if set
Optional<Tuple<Date,Date>>	getStartDate()	Returns an Optional containing the start date period used to filter if set
Optional<String>	getStatus()	Returns an Optional containing the status used to filter if set
Optional<String>	getTechnicalPresenter()	Returns an Optional containing the technical presenter's username used to filter if set
void	withAgent(String agent)	Add a ResourceListFilter filter to the query with the given subject
void	withComments(String comments)	Add a ResourceListFilter filter to the query with the given comments
void	withContributor(String contributor)	Add a ResourceListFilter filter to the query with the given contributor
void	withLanguage(String language)	Add a ResourceListFilter filter to the query with the given subject
void	withLocation(String location)	Add a ResourceListFilter filter to the query with the given subject
void	withPresenter(String presenter)	Add a ResourceListFilter filter to the query with the given presenter
void	withPublishers(String publishers)	Add a ResourceListFilter filter to the query with the given publishers
void	withSeriesId(String seriesId)	Add a ResourceListFilter filter to the query with the given seriesId
void	withStartDate(Tuple<Date,Date> startDate)	Add a ResourceListFilter filter to the query with the given start date period
void	withStatus(String status)	Add a ResourceListFilter filter to the query with the given status
void	withTechnicalPresenter(String presenter)	Add a ResourceListFilter filter to the query with the given technical presenter's username

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_SERIES_NAME

public static final String FILTER_SERIES_NAME

See Also:

• Constant Field Values

FILTER_PRESENTERS_BIBLIOGRAPHIC_NAME

public static final String FILTER_PRESENTERS_BIBLIOGRAPHIC_NAME

See Also:

• Constant Field Values

FILTER_PRESENTERS_TECHNICAL_NAME

public static final String FILTER_PRESENTERS_TECHNICAL_NAME

See Also:

• Constant Field Values

FILTER_CONTRIBUTORS_NAME

public static final String FILTER_CONTRIBUTORS_NAME

See Also:

• Constant Field Values

FILTER_LOCATION_NAME

public static final String FILTER_LOCATION_NAME

See Also:

• Constant Field Values

FILTER_AGENT_NAME

public static final String FILTER_AGENT_NAME

See Also:

• Constant Field Values

FILTER_LANGUAGE_NAME

public static final String FILTER_LANGUAGE_NAME

See Also:

• Constant Field Values

FILTER_STARTDATE_NAME

public static final String FILTER_STARTDATE_NAME

See Also:

• Constant Field Values

FILTER_STATUS_NAME

public static final String FILTER_STATUS_NAME

See Also:

• Constant Field Values

FILTER_COMMENTS_NAME

public static final String FILTER_COMMENTS_NAME

See Also:

• Constant Field Values

FILTER_PUBLISHER_NAME

public static final String FILTER_PUBLISHER_NAME

See Also:

• Constant Field Values

FILTER_TEXT_NAME

public static final String FILTER_TEXT_NAME

See Also:

• Constant Field Values

FILTER_IS_PUBLISHED_NAME

public static final String FILTER_IS_PUBLISHED_NAME

See Also:

• Constant Field Values

FILTER_IS_PUBLISHED_LABEL

public static final String FILTER_IS_PUBLISHED_LABEL

See Also:

• Constant Field Values

FILTER_READ_ACCESS_NAME

public static final String FILTER_READ_ACCESS_NAME

See Also:

• Constant Field Values

FILTER_READ_ACCESS_LABEL

public static final String FILTER_READ_ACCESS_LABEL

See Also:

• Constant Field Values

FILTER_WRITE_ACCESS_NAME

public static final String FILTER_WRITE_ACCESS_NAME

See Also:

• Constant Field Values

FILTER_WRITE_ACCESS_LABEL

public static final String FILTER_WRITE_ACCESS_LABEL

See Also:

• Constant Field Values

Constructor Details

EventListQuery

public EventListQuery()

Method Details

withSeriesId

public void withSeriesId(String seriesId)

Add a ResourceListFilter filter to the query with the given seriesId

Parameters:

seriesId - the seriesId to filter with

getSeriesId

public Optional<String> getSeriesId()

Returns an Optional containing the seriesId used to filter if set

Returns:

an Optional containing the seriesId or none.

withPresenter

public void withPresenter(String presenter)

Add a ResourceListFilter filter to the query with the given presenter

Parameters:

presenter - the presenter to filter for

getPresenter

public Optional<String> getPresenter()

Returns an Optional containing the presenter used to filter if set

Returns:

an Optional containing the presenter or none.

withTechnicalPresenter

public void withTechnicalPresenter(String presenter)

Add a ResourceListFilter filter to the query with the given technical presenter's username

Parameters:

presenter - presenter's username the presenter's username to filter for

getTechnicalPresenter

public Optional<String> getTechnicalPresenter()

Returns an Optional containing the technical presenter's username used to filter if set

Returns:

an Optional containing the presenter or none.

withContributor

public void withContributor(String contributor)

Add a ResourceListFilter filter to the query with the given contributor

Parameters:

contributor - the contributor to filter for

getContributor

public Optional<String> getContributor()

Returns an Optional containing the contributor used to filter if set

Returns:

an Optional containing the contributor or none.

withLocation

public void withLocation(String location)

Add a ResourceListFilter filter to the query with the given subject

Parameters:

location - the subject to filter for

getLocation

public Optional<String> getLocation()

Returns an Optional containing the location used to filter if set

Returns:

an Optional containing the location or none.

withAgent

public void withAgent(String agent)

Add a ResourceListFilter filter to the query with the given subject

Parameters:

agent - the agent to filter for

getAgent

public Optional<String> getAgent()

Returns an Optional containing the agent used to filter if set

Returns:

an Optional containing the agent or none.

withLanguage

public void withLanguage(String language)

Add a ResourceListFilter filter to the query with the given subject

Parameters:

language - the subject to filter for

getLanguage

public Optional<String> getLanguage()

Returns an Optional containing the language used to filter if set

Returns:

an Optional containing the language or none.

withStartDate

public void withStartDate(Tuple<Date,Date> startDate)

Add a ResourceListFilter filter to the query with the given start date period

Parameters:

startDate - the start date period as Tuple with two Date.

getStartDate

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

Returns an Optional containing the start date period used to filter if set

Returns:

an Optional containing the start date period or none.

withStatus

public void withStatus(String status)

Add a ResourceListFilter filter to the query with the given status

Parameters:

status - the status to filter for

getStatus

public Optional<String> getStatus()

Returns an Optional containing the status used to filter if set

Returns:

an Optional containing the status or none.

withComments

public void withComments(String comments)

Add a ResourceListFilter filter to the query with the given comments

Parameters:

comments - the comments to filter for

getComments

public Optional<String> getComments()

Returns an Optional containing the comments used to filter if set

Returns:

an Optional containing the comments or none.

withPublishers

public void withPublishers(String publishers)

Add a ResourceListFilter filter to the query with the given publishers

Parameters:

publishers - the publishers to filter for

getPublisher

public Optional<String> getPublisher()

Returns an Optional containing the publisher used to filter if set

Returns:

an Optional containing the publisher or none.

createSeriesFilter

public static ResourceListFilter<String> createSeriesFilter(Optional<String> seriesId)

Create a new ResourceListFilter based on the Series id

Parameters:

seriesId - the series id to filter on wrapped in an Optional or Optional.empty()

Returns:

a new ResourceListFilter for the Series name based query

createPresentersFilter

public static ResourceListFilter<String> createPresentersFilter(Optional<String> presenter)

Create a new ResourceListFilter based on a presenter's full name

Parameters:

presenter - 's name the presenters to filter on wrapped in an Optional or Optional.empty()

Returns:

a new ResourceListFilter for a presenters based query

createTechnicalPresentersFilter

public static ResourceListFilter<String> createTechnicalPresentersFilter(Optional<String> presenter)

Create a new ResourceListFilter based on a presenter's user name

Parameters:

presenter - the presenters to filter on wrapped in an Optional or Optional.empty()

Returns:

a new ResourceListFilter for a presenters based query

createContributorsFilter

public static ResourceListFilter<String> createContributorsFilter(Optional<String> contributor)

Create a new ResourceListFilter based on a contributor

Parameters:

contributor - the series id to filter on wrapped in an Optional or Optional.empty()

Returns:

a new ResourceListFilter for a contributor based query

createLocationFilter

public static ResourceListFilter<String> createLocationFilter(Optional<String> location)

Create a new ResourceListFilter based on a location

Parameters:

location - the location to filter on wrapped in an Optional or Optional.empty()

Returns:

a new ResourceListFilter for a location based query

createAgentFilter

public static ResourceListFilter<String> createAgentFilter(Optional<String> agent)

Create a new ResourceListFilter based on an agent

Parameters:

agent - the agent to filter on wrapped in an Optional or Optional.empty()

Returns:

a new ResourceListFilter for a location based query

createLanguageFilter

public static ResourceListFilter<String> createLanguageFilter(Optional<String> language)

Create a new ResourceListFilter based on a language

Parameters:

language - the language to filter on wrapped in an Optional or Optional.empty()

Returns:

a new ResourceListFilter for a language based query

createStartDateFilter

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

Create a new ResourceListFilter based on start date period

Parameters:

period - the period to filter on wrapped in an Optional or Optional.empty()

Returns:

a new ResourceListFilter for the given period

createStatusFilter

public static ResourceListFilter<String> createStatusFilter(Optional<String> status)

Create a new ResourceListFilter based on stats

Parameters:

status - the status to filter on wrapped in an Optional or Optional.empty()

Returns:

a new ResourceListFilter for progress based query

createCommentsFilter

public static ResourceListFilter<String> createCommentsFilter(Optional<String> comments)

Create a new ResourceListFilter based on comments

Parameters:

comments - the comments to filter on wrapped in an Optional or Optional.empty()

Returns:

a new ResourceListFilter for progress based query

createPublisherFilter

public static ResourceListFilter<String> createPublisherFilter(Optional<String> publisher)

Create a new ResourceListFilter based on publishers

Parameters:

publisher - the publisher to filter on wrapped in an Optional or Optional.empty()

Returns:

a new ResourceListFilter for progress based query

createIsPublishedFilter

public static ResourceListFilter<String> createIsPublishedFilter(Optional<String> isPublished)

Create a new ResourceListFilter based on is published

Parameters:

isPublished - the is published status to filter on wrapped in an Optional or Optional.empty()

Returns:

a new ResourceListFilter for progress based query

createReadAccessFilter

public static ResourceListFilter<String> createReadAccessFilter(Optional<String> readAccess)

Create a new ResourceListFilter based on a read role

Parameters:

readAccess - the read role to filter on wrapped in an Optional or Optional.empty()

Returns:

a new ResourceListFilter for a read role based query

createWriteAccessFilter

public static ResourceListFilter<String> createWriteAccessFilter(Optional<String> writeAccess)

Create a new ResourceListFilter based on a write role

Parameters:

writeAccess - the write role to filter on wrapped in an Optional or Optional.empty()

Returns:

a new ResourceListFilter for a write role based query