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