1 /*
2 * Licensed to The Apereo Foundation under one or more contributor license
3 * agreements. See the NOTICE file distributed with this work for additional
4 * information regarding copyright ownership.
5 *
6 *
7 * The Apereo Foundation licenses this file to you under the Educational
8 * Community License, Version 2.0 (the "License"); you may not use this file
9 * except in compliance with the License. You may obtain a copy of the License
10 * at:
11 *
12 * http://opensource.org/licenses/ecl2.txt
13 *
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
17 * License for the specific language governing permissions and limitations under
18 * the License.
19 *
20 */
21
22 package org.opencastproject.list.api;
23
24 import java.util.Map;
25
26 public interface ResourceListProvider {
27
28 /**
29 * Returns the names of the list(s) provided
30 *
31 * @return an array containing the lists available
32 */
33 String[] getListNames();
34
35 /**
36 * Returns the key-value list for the generator resource filtered with the given filter and based on the given
37 * organization context.
38 *
39 * @param listName
40 * the list name
41 * @param query
42 * the list query
43 * @return the key-value list for the generator resource
44 */
45 Map<String, String> getList(String listName, ResourceListQuery query)
46 throws ListProviderException;
47
48 /**
49 * Defines if keys and values of the given list should be translated in the administrative user interface.
50 *
51 * @param listName the name of the list
52 * @return if the results should be translated
53 */
54 boolean isTranslatable(String listName);
55
56 /**
57 * Returns the key of the default value in the list if customized, else null.
58 *
59 * @return key of default value or null
60 */
61 String getDefault();
62 }