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.group.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;
024
025/**
026 * This class represents a model for a {@link GroupDirectory}
027 */
028public interface GroupDirectoryModel
029{
030    /**
031     * Get the id of this user directory
032     * @return the id of this user directory
033     */
034    public String getId();
035    
036    /**
037     * Get the label of the directory.
038     * @return the label of the directory
039     */
040    public I18nizableText getLabel();
041    
042    /**
043     * Get the description text of the directory.
044     * @return the description of the directory
045     */
046    public I18nizableText getDescription();
047    
048    /**
049     * Get the configuration parameters
050     * @return The configuration parameters
051     */
052    public Map<String, ? extends ElementDefinition> getParameters();
053    
054    /**
055     * Returns the plugin name of declaration (for debug purpose)
056     * @return the plugin name
057     */
058    public String getPluginName();
059    
060    /**
061     * Get the group directory class
062     * @return the group directory class
063     */
064    public Class<GroupDirectory> getGroupDirectoryClass();
065    
066    /**
067     * Get the additional configuration for the implementation of {@link GroupDirectory}
068     * @return the additional configuration.
069     */
070    public Configuration getGroupDirectoryConfiguration();
071}