001/*
002 *  Copyright 2024 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.cms.properties.section;
017
018import java.util.Map;
019
020import org.ametys.plugins.repository.AmetysObject;
021import org.ametys.runtime.plugin.component.Prioritizable;
022import org.ametys.runtime.plugin.component.Supporter;
023
024/**
025 * Property section for the properties tool.
026 */
027public interface PropertySection extends Prioritizable, Supporter<AmetysObject>
028{
029    /**
030     * Get the identifier of the section
031     * @return the identifier
032     */
033    public String getId();
034    
035    /**
036     * Get the parameters to add in the request attributes of the next pipeline.
037     * @param ametysObject The Ametys object
038     * @return A {@link Map} of parameters
039     */
040    public Map<String, Object> getParameters(AmetysObject ametysObject);
041    
042    /**
043     * Get the pipeline to call to handle and render the section.
044     * @param ametysObject The Ametys object
045     * @return The path of the pipeline to call
046     */
047    public String getDataURL(AmetysObject ametysObject);
048}