Package org.opencastproject.list.api

Interface ResourceListProvider

public interface ResourceListProvider

  • Method Summary

    Modifier and Type
    Method
    Description
    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.

  • Method Details

    • getListNames

      String[] getListNames()
      Returns the names of the list(s) provided
      Returns:
      an array containing the lists available

    • getList

      Map<String,String> getList(String listName, ResourceListQuery query) throws ListProviderException
      Returns the key-value list for the generator resource filtered with the given filter and based on the given organization context.
      Parameters:
      listName - the list name
      query - the list query
      Returns:
      the key-value list for the generator resource
      Throws:
      ListProviderException

    • isTranslatable

      boolean isTranslatable(String listName)
      Defines if keys and values of the given list should be translated in the administrative user interface.
      Parameters:
      listName - the name of the list
      Returns:
      if the results should be translated

    • getDefault

      String getDefault()
      Returns the key of the default value in the list if customized, else null.
      Returns:
      key of default value or null