001/*
002 *  Copyright 2016 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.core.userpref;
017
018import java.util.Collection;
019import java.util.Map;
020
021/**
022 * Interface for classes providing user preferences.
023 */
024public interface UserPreferenceProvider
025{
026    /** The optional context variable including the current Ametys workspace (admin...) */
027    public static final String CONTEXT_VAR_WORKSPACE = "workspace";
028    
029    /**
030     * Get this provider's preferences.
031     * @param contextVars a Map of context variables.
032     * @return a Collection of preferences for the context.
033     */
034    public Collection<UserPreference> getPreferences(Map<String, String> contextVars);
035    
036}