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.plugins.contentio.synchronize;
017
018import java.util.Map;
019
020import org.ametys.runtime.i18n.I18nizableText;
021import org.ametys.runtime.parameter.Parameter;
022import org.ametys.runtime.parameter.ParameterHelper.ParameterType;
023
024/**
025 * Interface representing a model for a {@link SynchronizableContentsCollection}
026 */
027public interface SynchronizableContentsCollectionModel
028{   
029    /**
030     * Get the id of this model
031     * @return the id this model
032     */
033    public String getId();
034    
035    /**
036     * Get the label of this model
037     * @return the label of this model
038     */
039    public I18nizableText getLabel();
040    
041    /**
042     * Get the description of this model
043     * @return the description 
044     */
045    public I18nizableText getDescription();
046    
047    /**
048     * Get the configuration parameters
049     * @return The configuration parameters
050     */
051    public Map<String, ? extends Parameter<ParameterType>> getParameters();
052    
053    /**
054     * Returns the plugin name of declaration (for debug purpose)
055     * @return the plugin name
056     */
057    public String getPluginName();
058    
059    /**
060     * Get the synchronizable collection class
061     * @return the synchronizable collection class
062     */
063    public Class<SynchronizableContentsCollection> getSynchronizableCollectionClass();
064}