Index (Opencast :: list-providers-service 17-SNAPSHOT API)

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

A

AbstractListFilter<A> - Class in org.opencastproject.list.query: Abstract base class for the filter.
AbstractListFilter(Option<A>) - Constructor for class org.opencastproject.list.query.AbstractListFilter
addFilter(ResourceListFilter<?>) - Method in class org.opencastproject.list.impl.ResourceListQueryImpl
addProvider(String, ResourceListProvider) - Method in interface org.opencastproject.list.api.ListProvidersService: Adds an source to the service
addProvider(String, ResourceListProvider) - Method in class org.opencastproject.list.impl.ListProvidersServiceImpl
addProvider(String, ResourceListProvider, String) - Method in interface org.opencastproject.list.api.ListProvidersService
addProvider(String, ResourceListProvider, String) - Method in class org.opencastproject.list.impl.ListProvidersServiceImpl
addProvider(ResourceListProvider) - Method in class org.opencastproject.list.impl.ListProvidersServiceImpl: OSGi callback for provider.
availableFilters - Variable in class org.opencastproject.list.impl.ResourceListQueryImpl

B

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

C

canHandle(File) - Method in class org.opencastproject.list.impl.ListProvidersScanner

D

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

E

EmptyResourceListQuery - Class in org.opencastproject.list.impl: ResourceListQuery that should result in an empty list after execution.
EmptyResourceListQuery() - Constructor for class org.opencastproject.list.impl.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
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

getAvailableFilters() - Method in interface org.opencastproject.list.api.ResourceListQuery: Returns all the available ResourceListFilter filters with this query.
getAvailableFilters() - Method in class org.opencastproject.list.impl.EmptyResourceListQuery
getAvailableFilters() - Method in class org.opencastproject.list.impl.ResourceListQueryImpl
getAvailableProviders() - Method in interface org.opencastproject.list.api.ListProvidersService: Returns the resources list providers available
getAvailableProviders() - Method in class org.opencastproject.list.impl.ListProvidersServiceImpl
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.
getDefault(String) - Method in class org.opencastproject.list.impl.ListProvidersServiceImpl
getFilter(String) - Method in interface org.opencastproject.list.api.ResourceListQuery: Returns the filter with the given name
getFilter(String) - Method in class org.opencastproject.list.impl.EmptyResourceListQuery
getFilter(String) - Method in class org.opencastproject.list.impl.ResourceListQueryImpl
getFilters() - Method in interface org.opencastproject.list.api.ResourceListQuery: Returns all the ResourceListFilter set for the query.
getFilters() - Method in class org.opencastproject.list.impl.EmptyResourceListQuery
getFilters() - Method in class org.opencastproject.list.impl.ResourceListQueryImpl
getFilterValue(String) - Method in class org.opencastproject.list.impl.ResourceListQueryImpl: Returns the filter value wrapped in an Option 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 interface org.opencastproject.list.api.ResourceListQuery: Returns the limit for the resource query
getLimit() - Method in class org.opencastproject.list.impl.EmptyResourceListQuery
getLimit() - Method in class org.opencastproject.list.impl.ResourceListQueryImpl
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
getList(String, ResourceListQuery, boolean) - Method in class org.opencastproject.list.impl.ListProvidersServiceImpl
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 interface org.opencastproject.list.api.ResourceListQuery: Returns the offset for the resource query
getOffset() - Method in class org.opencastproject.list.impl.EmptyResourceListQuery
getOffset() - Method in class org.opencastproject.list.impl.ResourceListQueryImpl
getSortBy() - Method in interface org.opencastproject.list.api.ResourceListQuery: Returns the name of the field by which the list should be sorted
getSortBy() - Method in class org.opencastproject.list.impl.EmptyResourceListQuery
getSortBy() - Method in class org.opencastproject.list.impl.ResourceListQueryImpl
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.AbstractListFilter
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 interface org.opencastproject.list.api.ResourceListQuery: Returns if the given filter is or not set
hasFilter(String) - Method in class org.opencastproject.list.impl.EmptyResourceListQuery
hasFilter(String) - Method in class org.opencastproject.list.impl.ResourceListQueryImpl
hasProvider(String) - Method in interface org.opencastproject.list.api.ListProvidersService: Returns if the given source name is or not available
hasProvider(String) - Method in class org.opencastproject.list.impl.ListProvidersServiceImpl
hasProvider(String, String) - Method in interface org.opencastproject.list.api.ListProvidersService
hasProvider(String, String) - Method in class org.opencastproject.list.impl.ListProvidersServiceImpl

I

install(File) - Method in class org.opencastproject.list.impl.ListProvidersScanner
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.
isTranslatable(String) - Method in class org.opencastproject.list.impl.ListProvidersServiceImpl

L

LIST - Enum constant in enum class org.opencastproject.list.api.ResourceListFilter.SourceType
LIST_DEFAULT_KEY - Static variable in class org.opencastproject.list.impl.ListProvidersScanner: The key to define a default value
LIST_NAME_KEY - Static variable in class org.opencastproject.list.impl.ListProvidersScanner: The key to look for in the properties file to name the list provider.
LIST_ORG_KEY - Static variable in class org.opencastproject.list.impl.ListProvidersScanner: The key to attach this list to a particular org, if not present then all orgs can get list
LIST_PROVIDERS_DIRECTORY - Static variable in class org.opencastproject.list.impl.ListProvidersScanner: The directory name that has the properties file defining the list providers
LIST_TRANSLATABLE_KEY - Static variable in class org.opencastproject.list.impl.ListProvidersScanner: The key to look for in the properties file defining if the list's values should be translated
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.impl: This exception indicates that the queried list provider resource could not be found.
ListProviderNotFoundException(String) - Constructor for exception class org.opencastproject.list.impl.ListProviderNotFoundException: Constructs an exception with a simple message.
ListProvidersScanner - Class in org.opencastproject.list.impl
ListProvidersScanner() - Constructor for class org.opencastproject.list.impl.ListProvidersScanner
ListProvidersService - Interface in org.opencastproject.list.api: Service to generate list of key - value from different sources for autocomplete / filetring purpose
ListProvidersServiceImpl - Class in org.opencastproject.list.impl
ListProvidersServiceImpl() - Constructor for class org.opencastproject.list.impl.ListProvidersServiceImpl
ListProviderUtil - Class in org.opencastproject.list.util

O

org.opencastproject.list.api - package org.opencastproject.list.api
org.opencastproject.list.impl - package org.opencastproject.list.impl
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.impl.ResourceListQueryImpl
removeProvider(String) - Method in interface org.opencastproject.list.api.ListProvidersService: Removes the given source
removeProvider(String) - Method in class org.opencastproject.list.impl.ListProvidersServiceImpl
removeProvider(String, String) - Method in interface org.opencastproject.list.api.ListProvidersService
removeProvider(String, String) - Method in class org.opencastproject.list.impl.ListProvidersServiceImpl
removeProvider(ResourceListProvider) - Method in class org.opencastproject.list.impl.ListProvidersServiceImpl: OSGi callback for provider.
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
ResourceListQueryImpl - Class in org.opencastproject.list.impl
ResourceListQueryImpl() - Constructor for class org.opencastproject.list.impl.ResourceListQueryImpl

S

SELECT - Enum constant in enum class org.opencastproject.list.api.ResourceListFilter.SourceType
setLimit(Integer) - Method in class org.opencastproject.list.impl.ResourceListQueryImpl
setListProvidersService(ListProvidersService) - Method in class org.opencastproject.list.impl.ListProvidersScanner
setOffset(Integer) - Method in class org.opencastproject.list.impl.ResourceListQueryImpl
setSecurityService(SecurityService) - Method in class org.opencastproject.list.impl.ListProvidersServiceImpl: OSGi callback for security service
sortBy - Variable in class org.opencastproject.list.impl.ResourceListQueryImpl
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.

U

uninstall(File) - Method in class org.opencastproject.list.impl.ListProvidersScanner
update(File) - Method in class org.opencastproject.list.impl.ListProvidersScanner

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 C D E F G H I L O P R S U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form