Package org.opencastproject.list.impl

Class ListProvidersServiceImpl

java.lang.Object

org.opencastproject.list.impl.ListProvidersServiceImpl

All Implemented Interfaces:

ListProvidersService

public class ListProvidersServiceImpl
extends Object
implements ListProvidersService

Constructor Summary

Constructors

Constructor	Description
ListProvidersServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	addProvider(String listName, ResourceListProvider provider)	Adds an source to the service
void	addProvider(String listName, ResourceListProvider provider, String organizationId)
void	addProvider(ResourceListProvider provider)	OSGi callback for provider.
List<String>	getAvailableProviders()	Returns the resources list providers available
String	getDefault(String listName)	Defines the key of a default value in the given list.
Map<String,String>	getList(String listName, ResourceListQuery query, boolean inverseValueKey)	Returns the list for the given provider
boolean	hasProvider(String name)	Returns if the given source name is or not available
boolean	hasProvider(String name, String organizationId)
boolean	isTranslatable(String listName)	Defines if keys and values of the given list should be translated in the administrative user interface.
void	removeProvider(String name)	Removes the given source
void	removeProvider(String name, String organizationId)
void	removeProvider(ResourceListProvider provider)	OSGi callback for provider.
void	setSecurityService(org.opencastproject.security.api.SecurityService securityService)	OSGi callback for security service

Methods inherited from class java.lang.Object

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

Constructor Details

ListProvidersServiceImpl

public ListProvidersServiceImpl()

Method Details

setSecurityService

public void setSecurityService(org.opencastproject.security.api.SecurityService securityService)

OSGi callback for security service

addProvider

public void addProvider(ResourceListProvider provider)

OSGi callback for provider.

removeProvider

public void removeProvider(ResourceListProvider provider)

OSGi callback for provider.

getList

public Map<String,String> getList(String listName,
 ResourceListQuery query,
 boolean inverseValueKey)
                           throws ListProviderException

Description copied from interface: ListProvidersService

Returns the list for the given provider

Specified by:

getList in interface ListProvidersService

Parameters:

listName - The name of the source

query - The query for the list

Returns:

a list of tuple id - value from the given source

Throws:

ListProviderException

isTranslatable

public boolean isTranslatable(String listName)
                       throws ListProviderNotFoundException

Description copied from interface: ListProvidersService

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

Specified by:

isTranslatable in interface ListProvidersService

Parameters:

listName - the name of the list

Returns:

if the results should be translated

Throws:

ListProviderNotFoundException

getDefault

public String getDefault(String listName)
                  throws ListProviderNotFoundException

Description copied from interface: ListProvidersService

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

Specified by:

getDefault in interface ListProvidersService

Parameters:

listName - the name of the list

Returns:

the key of the default value

Throws:

ListProviderNotFoundException

addProvider

public void addProvider(String listName,
 ResourceListProvider provider)

Description copied from interface: ListProvidersService

Adds an source to the service

Specified by:

addProvider in interface ListProvidersService

Parameters:

listName - The name of the source

provider - The list provider to add

addProvider

public void addProvider(String listName,
 ResourceListProvider provider,
 String organizationId)

Specified by:

addProvider in interface ListProvidersService

removeProvider

public void removeProvider(String name)

Description copied from interface: ListProvidersService

Removes the given source

Specified by:

removeProvider in interface ListProvidersService

Parameters:

name - The provider to remove

removeProvider

public void removeProvider(String name,
 String organizationId)

Specified by:

removeProvider in interface ListProvidersService

hasProvider

public boolean hasProvider(String name)

Description copied from interface: ListProvidersService

Returns if the given source name is or not available

Specified by:

hasProvider in interface ListProvidersService

Parameters:

name - The source to check

Returns:

true if a source with the given name is available in the service

hasProvider

public boolean hasProvider(String name,
 String organizationId)

Specified by:

hasProvider in interface ListProvidersService

getAvailableProviders

public List<String> getAvailableProviders()

Description copied from interface: ListProvidersService

Returns the resources list providers available

Specified by:

getAvailableProviders in interface ListProvidersService

Returns:

the list of available providers