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.runtime.config;
017
018import org.ametys.runtime.i18n.I18nizableText;
019import org.ametys.runtime.parameter.ParameterCheckerDescriptor;
020
021/**
022 * Descriptor for a configuration parameter checker
023 */
024public class ConfigParameterCheckerDescriptor extends ParameterCheckerDescriptor
025{
026    /** The path of the configuration parameter to attach this parameter parameter checker to */
027    protected String _uiRefParamPath;
028    
029    /** The configuration group of the checked parameter */
030    protected I18nizableText _uiRefGroup;
031    
032    /** The configuration category of the checked parameter */
033    protected I18nizableText _uiRefCategory;
034
035    /**
036     * Retrieves the id of the parameter the parameter checker is attached to
037     * @return _uiRefParamId the id of the parameter
038     */
039    public String getUiRefParamId()
040    {
041        return _uiRefParamPath;
042    }
043    
044    /**
045     * Sets the path of the parameter the parameter checker is attached to
046     * @param uiRefParamPath the id of the parameter
047     */
048    public void setUiRefParamPath(String uiRefParamPath)
049    {
050        _uiRefParamPath = uiRefParamPath;
051    }
052    
053    /**
054     * Retrieves the text of the configuration group the parameter checker is attached to
055     * @return _uiRefGroup the text of the configuration group
056     */
057    public I18nizableText getUiRefGroup()
058    {
059        return _uiRefGroup;
060    }
061    
062    /**
063     * Sets the text of the configuration group the parameter checker is attached to
064     * @param uiRefGroup the text of the configuration group
065     */
066    public void setUiRefGroup(I18nizableText uiRefGroup)
067    {
068        _uiRefGroup = uiRefGroup;
069    }
070    
071    /**
072     * Retrieves the text of the configuration category the parameter checker is attached to
073     * @return _uiRefCategory the text of the configuration group
074     */
075    public I18nizableText getUiRefCategory()
076    {
077        return _uiRefCategory;
078    }
079    
080    /**
081     * Sets the text of the configuration category the parameter checker is attached to
082     * @param uiRefCategory the text of the configuration group
083     */
084    public void setUiRefCategory(I18nizableText uiRefCategory)
085    {
086        _uiRefCategory = uiRefCategory;
087    }
088}