001    /*
002     * Copyright 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.kfs.sys.document.service;
017    
018    import java.util.Map;
019    import java.util.Set;
020    
021    import org.kuali.kfs.sys.businessobject.AccountingLine;
022    import org.kuali.rice.kns.datadictionary.MaintainableFieldDefinition;
023    import org.kuali.rice.kns.web.ui.Field;
024    
025    /**
026     * An interface that represents a transformation on a single field; they can be grouped
027     * together and run at one time by FieldChangingAccountingLineRenderTransformImpl.
028     */
029    public interface AccountingLineFieldRenderingTransformation {
030       /**
031         * Performs a transformation on the field
032         * @param accountingLine the accounting line that is being rendered
033         * @param field the field to transform
034         * @param fieldDefinition the accounting line definition of the accounting line being rendered
035         * @param unconvertedValues a map of unconverted values
036         */
037        public abstract void transformField(AccountingLine accountingLine, Field field, MaintainableFieldDefinition fieldDefinition, Map unconvertedValues);
038    }