Class UsersListProvider
java.lang.Object
org.opencastproject.list.common.provider.UsersListProvider
- All Implemented Interfaces:
ResourceListProvider
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidactivate(org.osgi.framework.BundleContext bundleContext) Returns the key of the default value in the list if customized, else null.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[]Returns the names of the list(s) providedbooleanisTranslatable(String listName) Defines if keys and values of the given list should be translated in the administrative user interface.voidsetUserDirectoryService(UserDirectoryService userDirectoryService) OSGi callback for users services.
-
Field Details
-
NAME
- See Also:
-
NAME_AND_EMAIL
- See Also:
-
NAME_AND_USERNAME
- See Also:
-
USERNAME
- See Also:
-
EMAIL
- See Also:
-
NAME_ONLY
- See Also:
-
EMAIL_ONLY
- See Also:
-
ROLE_ONLY
- See Also:
-
USERDIRECTORY_ONLY
- See Also:
-
NAMES
-
-
Constructor Details
-
UsersListProvider
public UsersListProvider()
-
-
Method Details
-
activate
protected void activate(org.osgi.framework.BundleContext bundleContext) -
setUserDirectoryService
OSGi callback for users services. -
getListNames
Description copied from interface:ResourceListProviderReturns the names of the list(s) provided- Specified by:
getListNamesin interfaceResourceListProvider- Returns:
- an array containing the lists available
-
getList
Description copied from interface:ResourceListProviderReturns the key-value list for the generator resource filtered with the given filter and based on the given organization context.- Specified by:
getListin interfaceResourceListProvider- Parameters:
listName- the list namequery- the list query- Returns:
- the key-value list for the generator resource
-
isTranslatable
Description copied from interface:ResourceListProviderDefines if keys and values of the given list should be translated in the administrative user interface.- Specified by:
isTranslatablein interfaceResourceListProvider- Parameters:
listName- the name of the list- Returns:
- if the results should be translated
-
getDefault
Description copied from interface:ResourceListProviderReturns the key of the default value in the list if customized, else null.- Specified by:
getDefaultin interfaceResourceListProvider- Returns:
- key of default value or null
-