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 org.ametys.runtime.i18n.I18nizableText;
019import org.ametys.runtime.model.Model;
020
021/**
022 * Interface representing a model for a {@link SynchronizableContentsCollection}
023 */
024public interface SynchronizableContentsCollectionModel extends Model
025{   
026    /**
027     * Get the label of this model
028     * @return the label of this model
029     */
030    public I18nizableText getLabel();
031    
032    /**
033     * Get the description of this model
034     * @return the description 
035     */
036    public I18nizableText getDescription();
037    
038    /**
039     * Returns the plugin name of declaration (for debug purpose)
040     * @return the plugin name
041     */
042    public String getPluginName();
043    
044    /**
045     * Get the synchronizable collection class
046     * @return the synchronizable collection class
047     */
048    public Class<SynchronizableContentsCollection> getSynchronizableCollectionClass();
049    
050    public default String getFamilyId()
051    {
052        return SynchronizeContentsCollectionModelExtensionPoint.ROLE;
053    }
054}