Package org.opencastproject.list.common.query

Class SeriesListQuery

java.lang.Object

org.opencastproject.list.api.DefaultResourceListQuery

org.opencastproject.list.common.query.SeriesListQuery

All Implemented Interfaces:

ResourceListQuery

public class SeriesListQuery
extends DefaultResourceListQuery

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

• contributors
• subject
• language
• creator
• license
• access policy
• creation date

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FILTER_ACL_NAME
static final String	FILTER_ACL_PERMISSION_READ_NAME
static final String	FILTER_ACL_PERMISSION_WRITE_NAME
static final String	FILTER_CONTRIBUTORS_NAME
static final String	FILTER_CREATIONDATE_NAME
static final String	FILTER_CREATOR_NAME
static final String	FILTER_LANGUAGE_NAME
static final String	FILTER_LICENSE_NAME
static final String	FILTER_ORGANIZERS_NAME
static final String	FILTER_READ_ACCESS_LABEL
static final String	FILTER_READ_ACCESS_NAME
static final String	FILTER_SUBJECT_NAME
static final String	FILTER_TEXT_NAME
static final String	FILTER_TITLE_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
SeriesListQuery()

Method Summary

Modifier and Type	Method	Description
static ResourceListFilter<String>	createContributorsFilter(Optional<String> contributor)	Create a new ResourceListFilter based on a contributor
static ResourceListFilter<Tuple<Date,Date>>	createCreationDateFilter(Optional<Tuple<Date,Date>> period)	Create a new ResourceListFilter based on creation date period
static ResourceListFilter<String>	createCreatorFilter(Optional<String> creator)	Create a new ResourceListFilter based on a creator
static ResourceListFilter<String>	createLanguageFilter(Optional<String> language)	Create a new ResourceListFilter based on a language
static ResourceListFilter<String>	createLicenseFilter(Optional<String> license)	Create a new ResourceListFilter based on a license
static ResourceListFilter<String>	createOrganizersFilter(Optional<String> organizer)	Create a new ResourceListFilter based on a organizer
static ResourceListFilter<String>	createReadAccessFilter(Optional<String> readAccess)	Create a new ResourceListFilter based on a read role
static ResourceListFilter<Boolean>	createReadPermissionFilter(Optional<Boolean> value)
static ResourceListFilter<String>	createSubjectFilter(Optional<String> subject)	Create a new ResourceListFilter based on a subject
static ResourceListFilter<String>	createTitleFilter(Optional<String> title)	Create a new ResourceListFilter based on a title
static ResourceListFilter<String>	createWriteAccessFilter(Optional<String> writeAccess)	Create a new ResourceListFilter based on a write role
static ResourceListFilter<Boolean>	createWritePermissionFilter(Optional<Boolean> value)
Optional<String>	getContributor()	Returns an Optional containing the contributor used to filter if set
Optional<Tuple<Date,Date>>	getCreationDate()	Returns an Optional containing the creation date period used to filter if set
Optional<String>	getCreator()	Returns an Optional containing the creator used to filter if set
Optional<String>	getLanguage()	Returns an Optional containing the language used to filter if set
Optional<String>	getLicense()	Returns an Optional containing the license used to filter if set
Optional<String>	getOrganizer()	Returns an Optional containing the organizer used to filter if set
Optional<Boolean>	getReadPermission()
Optional<String>	getSubject()	Returns an Optional containing the subject used to filter if set
Optional<String>	getTitle()	Returns an Optional containing the title used to filter if set
Optional<Boolean>	getWritePermission()
void	withContributor(String contributor)	Add a ResourceListFilter filter to the query with the given contributor
void	withCreationDate(Tuple<Date,Date> creationDate)	Add a ResourceListFilter filter to the query with the given creation date period
void	withCreator(String creator)	Add a ResourceListFilter filter to the query with the given creator
void	withLanguage(String language)	Add a ResourceListFilter filter to the query with the given language
void	withLicense(String license)	Add a ResourceListFilter filter to the query with the given license
void	withOrganizer(String organizer)	Add a ResourceListFilter filter to the query with the given organizer
void	withoutPermissions()
void	withReadPermission(boolean value)
void	withSubject(String subject)	Add a ResourceListFilter filter to the query with the given subject
void	withTitle(String title)	Add a ResourceListFilter filter to the query with the given title
void	withWritePermission(boolean value)

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_ACL_NAME

public static final String FILTER_ACL_NAME

See Also:

• Constant Field Values

FILTER_ACL_PERMISSION_READ_NAME

public static final String FILTER_ACL_PERMISSION_READ_NAME

See Also:

• Constant Field Values

FILTER_ACL_PERMISSION_WRITE_NAME

public static final String FILTER_ACL_PERMISSION_WRITE_NAME

See Also:

• Constant Field Values

FILTER_CONTRIBUTORS_NAME

public static final String FILTER_CONTRIBUTORS_NAME

See Also:

• Constant Field Values

FILTER_CREATIONDATE_NAME

public static final String FILTER_CREATIONDATE_NAME

See Also:

• Constant Field Values

FILTER_CREATOR_NAME

public static final String FILTER_CREATOR_NAME

See Also:

• Constant Field Values

FILTER_TEXT_NAME

public static final String FILTER_TEXT_NAME

See Also:

• Constant Field Values

FILTER_LANGUAGE_NAME

public static final String FILTER_LANGUAGE_NAME

See Also:

• Constant Field Values

FILTER_LICENSE_NAME

public static final String FILTER_LICENSE_NAME

See Also:

• Constant Field Values

FILTER_ORGANIZERS_NAME

public static final String FILTER_ORGANIZERS_NAME

See Also:

• Constant Field Values

FILTER_SUBJECT_NAME

public static final String FILTER_SUBJECT_NAME

See Also:

• Constant Field Values

FILTER_TITLE_NAME

public static final String FILTER_TITLE_NAME

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

SeriesListQuery

public SeriesListQuery()

Method Details

withoutPermissions

public void withoutPermissions()

withReadPermission

public void withReadPermission(boolean value)

withWritePermission

public void withWritePermission(boolean value)

getReadPermission

public Optional<Boolean> getReadPermission()

getWritePermission

public Optional<Boolean> getWritePermission()

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.

withCreationDate

public void withCreationDate(Tuple<Date,Date> creationDate)

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

Parameters:

creationDate - the creation date period as Tuple with two Date.

getCreationDate

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

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

Returns:

an Optional containing the creation date period or none.

withCreator

public void withCreator(String creator)

Add a ResourceListFilter filter to the query with the given creator

Parameters:

creator - the creator to filter for

getCreator

public Optional<String> getCreator()

Returns an Optional containing the creator used to filter if set

Returns:

an Optional containing the creator or none.

withLanguage

public void withLanguage(String language)

Add a ResourceListFilter filter to the query with the given language

Parameters:

language - the language 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.

withLicense

public void withLicense(String license)

Add a ResourceListFilter filter to the query with the given license

Parameters:

license - the license to filter for

getLicense

public Optional<String> getLicense()

Returns an Optional containing the license used to filter if set

Returns:

an Optional containing the license or none.

withOrganizer

public void withOrganizer(String organizer)

Add a ResourceListFilter filter to the query with the given organizer

Parameters:

organizer - the organizer to filter for

getOrganizer

public Optional<String> getOrganizer()

Returns an Optional containing the organizer used to filter if set

Returns:

an Optional containing the organizer or none.

withSubject

public void withSubject(String subject)

Add a ResourceListFilter filter to the query with the given subject

Parameters:

subject - the subject to filter for

getSubject

public Optional<String> getSubject()

Returns an Optional containing the subject used to filter if set

Returns:

an Optional containing the subject or none.

withTitle

public void withTitle(String title)

Add a ResourceListFilter filter to the query with the given title

Parameters:

title - the subject to filter for

getTitle

public Optional<String> getTitle()

Returns an Optional containing the title used to filter if set

Returns:

an Optional containing the title or none.

createReadPermissionFilter

public static ResourceListFilter<Boolean> createReadPermissionFilter(Optional<Boolean> value)

createWritePermissionFilter

public static ResourceListFilter<Boolean> createWritePermissionFilter(Optional<Boolean> value)

createContributorsFilter

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

Create a new ResourceListFilter based on a contributor

Parameters:

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

Returns:

a new ResourceListFilter for a contributor based query

createCreatorFilter

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

Create a new ResourceListFilter based on a creator

Parameters:

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

Returns:

a new ResourceListFilter for a creator based query

createCreationDateFilter

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

Create a new ResourceListFilter based on creation date period

Parameters:

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

Returns:

a new ResourceListFilter for the given period

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

createLicenseFilter

public static ResourceListFilter<String> createLicenseFilter(Optional<String> license)

Create a new ResourceListFilter based on a license

Parameters:

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

Returns:

a new ResourceListFilter for a license based query

createOrganizersFilter

public static ResourceListFilter<String> createOrganizersFilter(Optional<String> organizer)

Create a new ResourceListFilter based on a organizer

Parameters:

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

Returns:

a new ResourceListFilter for a organizer based query

createSubjectFilter

public static ResourceListFilter<String> createSubjectFilter(Optional<String> subject)

Create a new ResourceListFilter based on a subject

Parameters:

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

Returns:

a new ResourceListFilter for a subject based query

createTitleFilter

public static ResourceListFilter<String> createTitleFilter(Optional<String> title)

Create a new ResourceListFilter based on a title

Parameters:

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

Returns:

a new ResourceListFilter for a title 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