/*

  * Copyright 2005-2009 The Kuali Foundation

  * 

  * Licensed under the Educational Community License, Version 2.0 (the "License"); you may not use this file except in

  * compliance with the License. You may obtain a copy of the License at

  * 

  * http://www.opensource.org/licenses/ecl2.php

  * 

  * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS

  * IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific

  * language governing permissions and limitations under the License.

  */

 package org.kuali.rice.kns.service;

 import java.util.List;

 import org.kuali.rice.kns.bo.ParameterDetailType;

 import org.kuali.rice.kns.datadictionary.AttributeDefinition;

 /**

  * This interface defines methods that a KualiConfiguration Service must provide. Provides methods for getting string

  * resources.

  */

 public interface RiceApplicationConfigurationService {

     /**

      * Given a property name (parameterName), returns the value associated with it.

      * 

      * @param parameterName

      * @return String associated with the given parameterName

      */

     String getConfigurationParameter( String parameterName ); 

     /**

      * This method can be used to supplement the list of ParameterDetailTypes defined in the database from other sources.

      * 

      * @return List<ParameterDetailedType> containing the detailed types configured in non-database sources

      */

     List<ParameterDetailType> getNonDatabaseComponents();

     /**

      * Checks whether this application is responsible for the package given.  It will

      * ensure that it falls within a set of configured parent packages.

      */

     boolean isResponsibleForPackage( String packageName );

     /**

      * Checks whether this application supports the given business object (whether

      * it is defined in the data dictionary) 

      */

     boolean supportsBusinessObjectClass( String businessObjectClassName );

     /**

          * This method will return the attribute definition from the local data dictionary.  It assumes that

          * the #supportsBusinessObjectClass(java.lang.String) method has already been checked to make sure that

          * this service will handle that class.  If not present, this method will return null.

          * 

          * This method also returns null if the given attribute definition can not be found on the business object.

      */

     AttributeDefinition getBusinessObjectAttributeDefinition( String businessObjectClassName, String attributeName );

     String getBaseLookupUrl( String businessObjectClassName );

     String getBaseInquiryUrl( String businessObjectClassName );

     String getBaseHelpUrl( String businessObjectClassName );

 }