1 /*
2 * Copyright 2007-2009 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.rice.krad.service;
17
18 import org.kuali.rice.core.api.component.Component;
19 import org.kuali.rice.krad.datadictionary.AttributeDefinition;
20
21 import java.util.List;
22
23 /**
24 * This service handles mediation between all RiceApplicationConfiguration services that are
25 * deployed in all Rice client applications on the bus. It's responsible for identifying
26 * which RiceApplicationConfiguration services to contact and dispatching service calls
27 * to them to properly implement the methods on the service.
28 *
29 * @author Kuali Rice Team (rice.collab@kuali.org)
30 *
31 */
32 public interface RiceApplicationConfigurationMediationService {
33
34 /**
35 * Returns the configuration parameter value for the given applicationId and parameterName.
36 * The applicationId is used to determine which RiceApplicationConfigurationService to
37 * call by looking up the applicationNamespaceCode associated with it's applicationId.
38 *
39 * @param applicationId
40 * @param parameterName
41 * @return
42 */
43 String getConfigurationParameter(String applicationId, String parameterName);
44
45 /**
46 * Returns the non-database components that have been published by all Rice client applications.
47 */
48 List<Component> getNonDatabaseComponents();
49
50 /**
51 * This method will return the attribute definition from the local data dictionary of the
52 * application which supports that business object. If not present in any application
53 * attached to the bus, this method will return null.
54 *
55 * This method also returns null if the given attribute definition can not be found on the business object.
56 */
57 AttributeDefinition getBusinessObjectAttributeDefinition( String businessObjectClassName, String attributeName );
58
59 String getBaseLookupUrl( String businessObjectClassName );
60 String getBaseInquiryUrl( String businessObjectClassName );
61 String getBaseHelpUrl( String businessObjectClassName );
62 }