org.kuali.coeus.propdev.api.s2s.S2SConfigurationService Maven / Gradle / Ivy

Go to download
/*
 * Kuali Coeus, a comprehensive research administration system for higher education.
 * 
 * Copyright 2005-2015 Kuali, Inc.
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 */
package org.kuali.coeus.propdev.api.s2s;

public interface S2SConfigurationService {

    /**
     * This method gets a config value for the s2s application from a config name as a String.
     * The name cannot be blank.  This method will return the config value or null
     * if the value cannot be found.
     *
     * @param name the name to retrieve the value for
     * @return the configuration value or null
     * @throws java.lang.IllegalArgumentException if the name is blank
     */
    String getValueAsString(String name);

    /**
     * This method gets a config value for the s2s application from a config name as a Boolean.
     * The name cannot be blank.  This method will return the config value or null
     * if the value cannot be found.
     *
     * 
     *   This method will return null if the parameter does not exist or is not a valid truth value.
     * 
     *
     * valid true values (case insensitive):
     * 
     *     Y
     *     true
     *     on
     *     1
     *     t
     *     enabled
     * 
     *
     * valid false values (case insensitive):
     * 
     *     N
     *     false
     *     off
     *     0
     *     f
     *     disabled
     * 
     *
     * @param name the name to retrieve the value for
     * @return the configuration value or null
     * @throws java.lang.IllegalArgumentException if the name is blank
     */
    Boolean getValueAsBoolean(String name);
}