Index

A B D E F G H I L O P R S V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addFilter(ResourceListFilter<?>) - Method in class org.opencastproject.list.api.DefaultResourceListQuery

addProvider(String, ResourceListProvider) - Method in interface org.opencastproject.list.api.ListProvidersService

Adds an source to the service

addProvider(String, ResourceListProvider, String) - Method in interface org.opencastproject.list.api.ListProvidersService

availableFilters - Variable in class org.opencastproject.list.api.DefaultResourceListQuery

B

BOOLEAN - Enum constant in enum class org.opencastproject.list.api.ResourceListFilter.SourceType

D

DATE - Enum constant in enum class org.opencastproject.list.api.ResourceListFilter.SourceType

DefaultResourceListQuery - Class in org.opencastproject.list.api

DefaultResourceListQuery() - Constructor for class org.opencastproject.list.api.DefaultResourceListQuery

E

EmptyResourceListQuery - Class in org.opencastproject.list.api

ResourceListQuery that should result in an empty list after execution.

EmptyResourceListQuery() - Constructor for class org.opencastproject.list.api.EmptyResourceListQuery

F

filterMap(Map<String, String>, ResourceListQuery) - Static method in class org.opencastproject.list.util.ListProviderUtil

Filtered a simple map with the given query using the limit and offset parameters

FiltersUtils - Class in org.opencastproject.list.util

Utility class providing helpers for all operations related to the filters.

FREETEXT - Enum constant in enum class org.opencastproject.list.api.ResourceListFilter.SourceType

FREETEXT - Static variable in interface org.opencastproject.list.api.ResourceListFilter

Denotes free text which may appear in any field.

G

generateFilter(Optional<A>, String, String, ResourceListFilter.SourceType, Optional<String>) - Static method in class org.opencastproject.list.util.FiltersUtils

Create a new ResourceListFilter following the parameters given

getAvailableFilters() - Method in class org.opencastproject.list.api.DefaultResourceListQuery

getAvailableFilters() - Method in class org.opencastproject.list.api.EmptyResourceListQuery

getAvailableFilters() - Method in interface org.opencastproject.list.api.ResourceListQuery

Returns all the available ResourceListFilter filters with this query.

getAvailableProviders() - Method in interface org.opencastproject.list.api.ListProvidersService

Returns the resources list providers available

getDefault() - Method in interface org.opencastproject.list.api.ResourceListProvider

Returns the key of the default value in the list if customized, else null.

getDefault(String) - Method in interface org.opencastproject.list.api.ListProvidersService

Defines the key of a default value in the given list.

getFilter(String) - Method in class org.opencastproject.list.api.DefaultResourceListQuery

getFilter(String) - Method in class org.opencastproject.list.api.EmptyResourceListQuery

getFilter(String) - Method in interface org.opencastproject.list.api.ResourceListQuery

Returns the filter with the given name

getFilters() - Method in class org.opencastproject.list.api.DefaultResourceListQuery

getFilters() - Method in class org.opencastproject.list.api.EmptyResourceListQuery

getFilters() - Method in interface org.opencastproject.list.api.ResourceListQuery

Returns all the ResourceListFilter set for the query.

getFilterValue(String) - Method in class org.opencastproject.list.api.DefaultResourceListQuery

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

getLabel() - Method in interface org.opencastproject.list.api.ResourceListFilter

Returns the filter label as translation key.

getLabel() - Method in class org.opencastproject.list.query.StringListFilter

getLimit() - Method in class org.opencastproject.list.api.DefaultResourceListQuery

getLimit() - Method in class org.opencastproject.list.api.EmptyResourceListQuery

getLimit() - Method in interface org.opencastproject.list.api.ResourceListQuery

Returns the limit for the resource query

getList(String, ResourceListQuery) - Method in interface org.opencastproject.list.api.ResourceListProvider

Returns the key-value list for the generator resource filtered with the given filter and based on the given organization context.

getList(String, ResourceListQuery, boolean) - Method in interface org.opencastproject.list.api.ListProvidersService

Returns the list for the given provider

getListNames() - Method in interface org.opencastproject.list.api.ResourceListProvider

Returns the names of the list(s) provided

getName() - Method in interface org.opencastproject.list.api.ResourceListFilter

Returns the name of this filter target field

getName() - Method in class org.opencastproject.list.query.StringListFilter

getOffset() - Method in class org.opencastproject.list.api.DefaultResourceListQuery

getOffset() - Method in class org.opencastproject.list.api.EmptyResourceListQuery

getOffset() - Method in interface org.opencastproject.list.api.ResourceListQuery

Returns the offset for the resource query

getSortBy() - Method in class org.opencastproject.list.api.DefaultResourceListQuery

getSortBy() - Method in class org.opencastproject.list.api.EmptyResourceListQuery

getSortBy() - Method in interface org.opencastproject.list.api.ResourceListQuery

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

getSourceType() - Method in interface org.opencastproject.list.api.ResourceListFilter

Return the type of the filter

getSourceType() - Method in class org.opencastproject.list.query.StringListFilter

getValue() - Method in interface org.opencastproject.list.api.ResourceListFilter

Returns the value of the filter

getValue() - Method in class org.opencastproject.list.query.StringListFilter

getValuesListName() - Method in interface org.opencastproject.list.api.ResourceListFilter

Returns the name of the list containing the possible values for this filter.

getValuesListName() - Method in class org.opencastproject.list.query.StringListFilter

H

hasFilter(String) - Method in class org.opencastproject.list.api.DefaultResourceListQuery

hasFilter(String) - Method in class org.opencastproject.list.api.EmptyResourceListQuery

hasFilter(String) - Method in interface org.opencastproject.list.api.ResourceListQuery

Returns if the given filter is or not set

hasProvider(String) - Method in interface org.opencastproject.list.api.ListProvidersService

Returns if the given source name is or not available

hasProvider(String, String) - Method in interface org.opencastproject.list.api.ListProvidersService

I

invertMap(Map<String, String>) - Static method in class org.opencastproject.list.util.ListProviderUtil

Invert the key & value in the given map

isTranslatable(String) - Method in interface org.opencastproject.list.api.ListProvidersService

Defines if keys and values of the given list should be translated in the administrative user interface.

isTranslatable(String) - Method in interface org.opencastproject.list.api.ResourceListProvider

Defines if keys and values of the given list should be translated in the administrative user interface.

L

LIST - Enum constant in enum class org.opencastproject.list.api.ResourceListFilter.SourceType

ListProviderException - Exception Class in org.opencastproject.list.api

An exception which indicates an error from the list provider

ListProviderException(String) - Constructor for exception class org.opencastproject.list.api.ListProviderException

Constructor without cause.

ListProviderException(String, Throwable) - Constructor for exception class org.opencastproject.list.api.ListProviderException

Full fledged constructor.

ListProviderNotFoundException - Exception Class in org.opencastproject.list.api

This exception indicates that the queried list provider resource could not be found.

ListProviderNotFoundException(String) - Constructor for exception class org.opencastproject.list.api.ListProviderNotFoundException

Constructs an exception with a simple message.

ListProvidersService - Interface in org.opencastproject.list.api

Service to generate list of key - value from different sources for autocomplete / filetring purpose

ListProviderUtil - Class in org.opencastproject.list.util

O

org.opencastproject.list.api - package org.opencastproject.list.api

org.opencastproject.list.query - package org.opencastproject.list.query

org.opencastproject.list.util - package org.opencastproject.list.util

P

PERIOD - Enum constant in enum class org.opencastproject.list.api.ResourceListFilter.SourceType

R

removeFilter(ResourceListFilter<?>) - Method in class org.opencastproject.list.api.DefaultResourceListQuery

removeProvider(String) - Method in interface org.opencastproject.list.api.ListProvidersService

Removes the given source

removeProvider(String, String) - Method in interface org.opencastproject.list.api.ListProvidersService

ResourceListFilter<A> - Interface in org.opencastproject.list.api

Resource list filter interface

ResourceListFilter.SourceType - Enum Class in org.opencastproject.list.api

ResourceListProvider - Interface in org.opencastproject.list.api

ResourceListQuery - Interface in org.opencastproject.list.api

Query for the resource list

S

SELECT - Enum constant in enum class org.opencastproject.list.api.ResourceListFilter.SourceType

setLimit(Integer) - Method in class org.opencastproject.list.api.DefaultResourceListQuery

setOffset(Integer) - Method in class org.opencastproject.list.api.DefaultResourceListQuery

sortBy - Variable in class org.opencastproject.list.api.DefaultResourceListQuery

sortMapByValue(Map<String, String>, boolean) - Static method in class org.opencastproject.list.util.ListProviderUtil

Sorts the given map by its values, ascendantly or not

StringListFilter - Class in org.opencastproject.list.query

Simple ResourceListFilter implementation for freetext filter

StringListFilter(String) - Constructor for class org.opencastproject.list.query.StringListFilter

This constructor is a shortcut for free-text filters.

StringListFilter(String, String) - Constructor for class org.opencastproject.list.query.StringListFilter

Standard constructor, accepting a key and a value.

V

valueOf(String) - Static method in enum class org.opencastproject.list.api.ResourceListFilter.SourceType

Returns the enum constant of this class with the specified name.

values() - Static method in enum class org.opencastproject.list.api.ResourceListFilter.SourceType

Returns an array containing the constants of this enum class, in the order they are declared.

A B D E F G H I L O P R S V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form