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.user.directory;
017
018import java.util.Map;
019
020import org.apache.avalon.framework.configuration.Configuration;
021
022import org.ametys.runtime.i18n.I18nizableText;
023import org.ametys.runtime.model.ElementDefinition;
024import org.ametys.runtime.model.checker.ItemCheckerDescriptor;
025
026/**
027 * This class represents a model for a {@link UserDirectory}
028 */
029public interface UserDirectoryModel
030{
031    /**
032     * Get the id of this user directory
033     * @return the id of this user directory
034     */
035    public String getId();
036    
037    /**
038     * Get the label of the directory.
039     * @return the label of the directory
040     */
041    public I18nizableText getLabel();
042    
043    /**
044     * Get the description text of the directory.
045     * @return the description of the directory
046     */
047    public I18nizableText getDescription();
048    
049    /**
050     * Get the configuration parameters
051     * @return The configuration parameters
052     */
053    public Map<String, ? extends ElementDefinition> getParameters();
054    
055    /**
056     * Get the configuration parameter checkers
057     * @return The configuration parameter checkers
058     */
059    public Map<String, ? extends ItemCheckerDescriptor> getParameterCheckers();
060    
061    /**
062     * Returns the plugin name of declaration (for debug purpose)
063     * @return the plugin name
064     */
065    public String getPluginName();
066    
067    /**
068     * Get the user directory class
069     * @return the user directory class
070     */
071    public Class<UserDirectory> getUserDirectoryClass();
072    
073    /**
074     * Get the additional configuration for the implementation of {@link UserDirectory}
075     * @return the additional configuration.
076     */
077    public Configuration getUserDirectoryConfiguration();
078
079}