001    /**
002     * Copyright 2005-2011 The Kuali Foundation
003     *
004     * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
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     */
016    package org.kuali.rice.krad.service;
017    
018    import org.kuali.rice.core.api.uif.RemotableAttributeField;
019    
020    /**
021     * Provides service methods for building and validate {@link RemotableAttributeField} definitions from data
022     * dictionary {@link org.kuali.rice.krad.datadictionary.AttributeDefinition} configurations
023     *
024     * <p>
025     * Used by the default type services {@link org.kuali.rice.krad.workflow.DataDictionaryPeopleFlowTypeServiceImpl} to
026     * build the remotable fields for the type attributes
027     * </p>
028     *
029     * @author Kuali Rice Team (rice.collab@kuali.org)
030     */
031    public interface DataDictionaryRemoteFieldService {
032    
033        /**
034         * Builds and returns an {@link RemotableAttributeField} instance based on the data dictionary attribute definition
035         * that is associated with the given component class name (business object or data object entry) and the given
036         * attribute name
037         *
038         * <p>
039         * If an attribute definition is not found a runtime exception should be thrown
040         * </p>
041         *
042         * @param componentClassName - class name for the attribute, used to find the data dictionary entry
043         * @param attributeName - name of the attribute whose definition should be used
044         * @return RemotableAttributeField instance built
045         */
046        public RemotableAttributeField buildRemotableFieldFromAttributeDefinition(String componentClassName,
047                String attributeName);
048    
049    }