/* 
 * JBoss, Home of Professional Open Source 
 * Copyright 2013 Red Hat Inc. and/or its affiliates and other contributors
 * as indicated by the @author tags. All rights reserved. 
 * See the copyright.txt in the distribution for a 
 * full listing of individual contributors.
 *
 * This copyrighted material is made available to anyone wishing to use, 
 * modify, copy, or redistribute it subject to the terms and conditions 
 * of the GNU Lesser General Public License, v. 2.1. 
 * This program is distributed in the hope that it will be useful, but WITHOUT A 
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A 
 * PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details. 
 * You should have received a copy of the GNU Lesser General Public License, 
 * v.2.1 along with this distribution; if not, write to the Free Software 
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 
 * MA  02110-1301, USA.
 */
package org.switchyard.component.camel.common.model;

import java.util.List;
import java.util.Map;

import org.switchyard.config.model.Model;

/**
 * "additionalUriParameters" configuration model.
 */
public interface AdditionalUriParametersModel extends Model {

    /** The "additionalUriParameters" name. */
    public static final String ADDITIONAL_URI_PARAMETERS = "additionalUriParameters";

    /**
     * Gets the child parameter models.
     * @return the child parameter models
     */
    public List<ParameterModel> getParameters();

    /**
     * Adds a child parameter model.
     * @param parameter the child parameter model to add
     * @return this AdditionalUriParametersModel (useful for chaining)
     */
    public AdditionalUriParametersModel addParameter(ParameterModel parameter);
    
    /**
     * Remove a parameter model by name.
     * @param name name of the parameter
     * @return parameter with the specified name, or null if no such parameter exists
     */
    public ParameterModel removeParameter(String name);
    
    /**
     * Converts this ParametersModel to a Map<String,String>.
     * @return the Map<String,String>
     */
    public Map<String,String> toMap();


}
