Package org.opencastproject.event.comment.list

Class EventCommentsListProvider

java.lang.Object

org.opencastproject.event.comment.list.EventCommentsListProvider

All Implemented Interfaces:

ResourceListProvider

public class EventCommentsListProvider
extends Object
implements ResourceListProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EventCommentsListProvider.CommentsFilterList	The list of filter criteria for this provider
static enum	EventCommentsListProvider.RESOLUTION	The resolutions

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROVIDER_PREFIX

Constructor Summary

Constructors

Constructor	Description
EventCommentsListProvider()

Method Summary

Modifier and Type	Method	Description
protected void	activate(org.osgi.framework.BundleContext bundleContext)
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.
static String	getListNameFromFilter(EventCommentsListProvider.CommentsFilterList filter)	Returns the list name related to the given filter
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	setEventCommentService(EventCommentService eventCommentService)	OSGi callback for the event comment service.

Methods inherited from class java.lang.Object

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

Field Details

PROVIDER_PREFIX

public static final String PROVIDER_PREFIX

See Also:

• Constant Field Values

Constructor Details

EventCommentsListProvider

public EventCommentsListProvider()

Method Details

activate

protected void activate(org.osgi.framework.BundleContext bundleContext)

setEventCommentService

public void setEventCommentService(EventCommentService eventCommentService)

OSGi callback for the event comment service.

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

getListNameFromFilter

public static String getListNameFromFilter(EventCommentsListProvider.CommentsFilterList filter)

Returns the list name related to the given filter

Parameters:

filter - the filter from which the list name is needed

Returns:

the list name related to the given filter

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