001/*
002 *  Copyright 2018 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.runtime.model;
017
018import java.util.Arrays;
019import java.util.Collection;
020
021/**
022 * Interface of model classes for parameters or attributes
023 */
024public interface Model extends ModelItemContainer
025{
026    /**
027     * Creates a {@link Model} with the given {@link ModelItem}s
028     * @param id the model identifier
029     * @param familyId the model family identifier
030     * @param modelItems the model items
031     * @return the created {@link Model}
032     */
033    public static Model of(String id, String familyId, ModelItem... modelItems)
034    {
035        Collection<? extends ModelItem> modelItemsAsList = Arrays.asList(modelItems);
036        
037        Model model = new Model()
038        {
039            public Collection< ? extends ModelItem> getModelItems()
040            {
041                return modelItemsAsList;
042            }
043            
044            public String getId()
045            {
046                return id;
047            }
048            
049            public String getFamilyId()
050            {
051                return familyId;
052            }
053        };
054        
055        for (ModelItem modelItem : modelItems)
056        {
057            modelItem.setModel(model);
058        }
059        
060        return model;
061    }
062    
063    /**
064     * Retrieves the model id (an id must be unique in the family {@link #getFamilyId()}
065     * @return model id (for example the content type id for a content)
066     */
067    public String getId();
068    
069    /**
070     * Retrieves the Family Id (for example the extension point)
071     * Each model Id have to be unique in it's family Id
072     * @return content point (for example "org.ametys.cms.contenttype.ContentTypeExtensionPoint" for a content)
073     */
074    public String getFamilyId();
075}