Package org.opencastproject.themes.list

Class ThemesListProvider

java.lang.Object

org.opencastproject.themes.list.ThemesListProvider

All Implemented Interfaces:

ResourceListProvider

public class ThemesListProvider
extends Object
implements ResourceListProvider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DESCRIPTION
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
ThemesListProvider()

Method Summary

Modifier and Type	Method	Description
protected void	activate()
String	getDefault()	Returns the key of the default value in the list if customized, else null.
Map<String,String>	getList(String listName, ResourceListQuery query)	Returns the key-value list for the generator resource filtered with the given filter and based on the given organization context.
String[]	getListNames()	Returns the names of the list(s) provided
boolean	isTranslatable(String listName)	Defines if keys and values of the given list should be translated in the administrative user interface.
void	setThemesServiceDatabase(ThemesServiceDatabase themesServiceDatabase)	OSGi callback for the themes service database.

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

• Constant Field Values

Constructor Details

ThemesListProvider

public ThemesListProvider()

Method Details

activate

protected void activate()

setThemesServiceDatabase

public void setThemesServiceDatabase(ThemesServiceDatabase themesServiceDatabase)

OSGi callback for the themes service database.

getListNames

public String[] getListNames()

Description copied from interface: ResourceListProvider

Returns the names of the list(s) provided

Specified by:

getListNames in interface ResourceListProvider

Returns:

an array containing the lists available

getList

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

Description copied from interface: ResourceListProvider

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

Specified by:

getList in interface ResourceListProvider

Parameters:

listName - the list name

query - the list query

Returns:

the key-value list for the generator resource

Throws:

ListProviderException

isTranslatable

public boolean isTranslatable(String listName)

Description copied from interface: ResourceListProvider

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

Specified by:

isTranslatable in interface ResourceListProvider

Parameters:

listName - the name of the list

Returns:

if the results should be translated

getDefault

public String getDefault()

Description copied from interface: ResourceListProvider

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

Specified by:

getDefault in interface ResourceListProvider

Returns:

key of default value or null