Package org.opencastproject.list.common.provider

Class UsersListProvider

java.lang.Object

org.opencastproject.list.common.provider.UsersListProvider

All Implemented Interfaces:

ResourceListProvider

public class UsersListProvider
extends Object
implements ResourceListProvider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EMAIL
static final String	EMAIL_ONLY
static final String	NAME
static final String	NAME_AND_EMAIL
static final String	NAME_AND_USERNAME
static final String	NAME_ONLY
protected static final String[]	NAMES
static final String	ROLE_ONLY
static final String	USERDIRECTORY_ONLY
static final String	USERNAME

Constructor Summary

Constructors

Constructor	Description
UsersListProvider()

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.
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	setUserDirectoryService(UserDirectoryService userDirectoryService)	OSGi callback for users services.

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

NAME_AND_EMAIL

public static final String NAME_AND_EMAIL

See Also:

• Constant Field Values

NAME_AND_USERNAME

public static final String NAME_AND_USERNAME

See Also:

• Constant Field Values

USERNAME

public static final String USERNAME

See Also:

• Constant Field Values

EMAIL

public static final String EMAIL

See Also:

• Constant Field Values

NAME_ONLY

public static final String NAME_ONLY

See Also:

• Constant Field Values

EMAIL_ONLY

public static final String EMAIL_ONLY

See Also:

• Constant Field Values

ROLE_ONLY

public static final String ROLE_ONLY

See Also:

• Constant Field Values

USERDIRECTORY_ONLY

public static final String USERDIRECTORY_ONLY

See Also:

• Constant Field Values

NAMES

protected static final String[] NAMES

Constructor Details

UsersListProvider

public UsersListProvider()

Method Details

activate

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

setUserDirectoryService

public void setUserDirectoryService(UserDirectoryService userDirectoryService)

OSGi callback for users services.

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)

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

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