| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| DataDictionaryRemoteFieldService |
|
| 1.0;1 |
| 1 | /** | |
| 2 | * Copyright 2005-2011 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.uif.RemotableAttributeField; | |
| 19 | ||
| 20 | /** | |
| 21 | * Provides service methods for building and validate {@link RemotableAttributeField} definitions from data | |
| 22 | * dictionary {@link org.kuali.rice.krad.datadictionary.AttributeDefinition} configurations | |
| 23 | * | |
| 24 | * <p> | |
| 25 | * Used by the default type services {@link org.kuali.rice.krad.workflow.DataDictionaryPeopleFlowTypeServiceImpl} to | |
| 26 | * build the remotable fields for the type attributes | |
| 27 | * </p> | |
| 28 | * | |
| 29 | * @author Kuali Rice Team (rice.collab@kuali.org) | |
| 30 | */ | |
| 31 | public interface DataDictionaryRemoteFieldService { | |
| 32 | ||
| 33 | /** | |
| 34 | * Builds and returns an {@link RemotableAttributeField} instance based on the data dictionary attribute definition | |
| 35 | * that is associated with the given component class name (business object or data object entry) and the given | |
| 36 | * attribute name | |
| 37 | * | |
| 38 | * <p> | |
| 39 | * If an attribute definition is not found a runtime exception should be thrown | |
| 40 | * </p> | |
| 41 | * | |
| 42 | * @param componentClassName - class name for the attribute, used to find the data dictionary entry | |
| 43 | * @param attributeName - name of the attribute whose definition should be used | |
| 44 | * @return RemotableAttributeField instance built | |
| 45 | */ | |
| 46 | public RemotableAttributeField buildRemotableFieldFromAttributeDefinition(String componentClassName, | |
| 47 | String attributeName); | |
| 48 | ||
| 49 | } |