001/*
002 * Copyright 2008 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 */
016package org.kuali.ole.sys.document.datadictionary;
017
018import org.apache.commons.lang.StringUtils;
019import org.kuali.ole.sys.businessobject.AccountingLine;
020import org.kuali.ole.sys.context.SpringContext;
021import org.kuali.ole.sys.document.service.AccountingLineRenderingService;
022import org.kuali.ole.sys.document.web.AccountingLineViewCurrentBaseAmount;
023import org.kuali.ole.sys.document.web.TableJoining;
024import org.kuali.rice.kns.datadictionary.MaintainableFieldDefinition;
025import org.kuali.rice.kns.service.DataDictionaryService;
026import org.kuali.rice.kns.util.FieldUtils;
027import org.kuali.rice.kns.web.ui.Field;
028import org.kuali.rice.kns.web.ui.FieldBridge;
029import org.kuali.rice.krad.datadictionary.DataDictionary;
030import org.kuali.rice.krad.datadictionary.exception.AttributeValidationException;
031
032/**
033 * The definition for an amount field which reports both current and base amounts
034 */
035public class AccountingLineViewCurrentBaseAmountFieldDefinition extends MaintainableFieldDefinition implements AccountingLineViewRenderableElementDefinition {
036    private String currentAmountPropertyName;
037    private String baseAmountPropertyName;
038    private boolean useShortLabels = false;
039    
040    /**
041     * Creates a property initiated AccountingLineViewCurrentBaseAmount element
042     * @see org.kuali.ole.sys.document.datadictionary.AccountingLineViewRenderableElementDefinition#createLayoutElement(java.lang.Class)
043     */
044    public TableJoining createLayoutElement(Class<? extends AccountingLine> accountingLineClass) {
045        AccountingLineViewCurrentBaseAmount layoutElement = new AccountingLineViewCurrentBaseAmount();
046        
047        layoutElement.setBaseAmountField(createFieldForPropertyName(baseAmountPropertyName, accountingLineClass));
048        layoutElement.setBaseAmountFieldDefinition(createFieldDefinitionForProperty(baseAmountPropertyName));
049        
050        layoutElement.setCurrentAmountField(createFieldForPropertyName(currentAmountPropertyName, accountingLineClass));
051        layoutElement.setCurrentAmountFieldDefinition(createFieldDefinitionForProperty(currentAmountPropertyName));
052        
053        layoutElement.setDefinition(this);
054        
055        return layoutElement;
056    }
057    
058    /**
059     * Creates a field for the given AccountingLine class and property name
060     * @param propertyName the name of the property to create a Field for
061     * @param accountingLineClass the Class of the AccountingLine we're planning on rendering
062     * @return an appropriately created Field
063     */
064    protected Field createFieldForPropertyName(String propertyName, Class<? extends AccountingLine> accountingLineClass) {
065        Field realField = FieldUtils.getPropertyField(accountingLineClass, propertyName, false);
066        FieldBridge.setupField(realField, this, null);
067        if (useShortLabels) {
068            org.kuali.rice.krad.datadictionary.BusinessObjectEntry boEntry = SpringContext.getBean(DataDictionaryService.class).getDataDictionary().getBusinessObjectEntry(accountingLineClass.getName());
069            realField.setFieldLabel(boEntry.getAttributeDefinition(propertyName).getShortLabel());
070        }
071        return realField;
072    }
073    
074    /**
075     * Creates an AccountingLineViewFieldDefinition for the given property name
076     * @param propertyName the name of the field property that we're creating a definition for
077     * @return an appropriately created AccountingLineViewFieldDefinition
078     */
079    protected AccountingLineViewFieldDefinition createFieldDefinitionForProperty(String propertyName) {
080        AccountingLineViewFieldDefinition fieldDefinition = SpringContext.getBean(AccountingLineRenderingService.class).createGenericAccountingLineViewFieldDefinition(this);
081        fieldDefinition.setName(propertyName);
082        return fieldDefinition;
083    }
084    
085    /**
086     * @see org.kuali.rice.kns.datadictionary.MaintainableFieldDefinition#completeValidation(java.lang.Class, java.lang.Class)
087     */
088    @Override
089    public void completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass) {
090        if (StringUtils.isBlank(currentAmountPropertyName)) {
091            throw new AttributeValidationException("The currentAmountPropertyName property must be specified on the AccountingLineView-CurentBaseAmountField definition for "+rootBusinessObjectClass.getName());
092        }
093        
094        if (StringUtils.isBlank(baseAmountPropertyName)) {
095            throw new AttributeValidationException("The baseAmountPropertyName property must be specified on the AccountingLineView-CurentBaseAmountField definition for "+rootBusinessObjectClass.getName());
096        }
097        
098        if (!StringUtils.isBlank(getName())) {
099            throw new AttributeValidationException("please do not specify name on the AccountingLineView-CurentBaseAmountField definition for "+rootBusinessObjectClass.getName());
100        }
101        
102        if (!DataDictionary.isPropertyOf(rootBusinessObjectClass, getCurrentAmountPropertyName())) {
103            throw new AttributeValidationException("unable to find attribute or collection named '" + getCurrentAmountPropertyName() + "' in rootBusinessObjectClass '" + rootBusinessObjectClass.getName() + "' (" + "" + ")");
104        }
105
106        if (!DataDictionary.isPropertyOf(rootBusinessObjectClass, getBaseAmountPropertyName())) {
107            throw new AttributeValidationException("unable to find attribute or collection named '" + getBaseAmountPropertyName() + "' in rootBusinessObjectClass '" + rootBusinessObjectClass.getName() + "' (" + "" + ")");
108        }
109        
110        if (defaultValueFinderClass != null && defaultValue != null) {
111            throw new AttributeValidationException("Both defaultValue and defaultValueFinderClass can not be specified on attribute " + getName() + " in rootBusinessObjectClass " + rootBusinessObjectClass.getName());
112        }
113    }
114
115    /**
116     * Gets the baseAmountPropertyName attribute. 
117     * @return Returns the baseAmountPropertyName.
118     */
119    public String getBaseAmountPropertyName() {
120        return baseAmountPropertyName;
121    }
122
123    /**
124     * Sets the baseAmountPropertyName attribute value.
125     * @param baseAmountPropertyName The baseAmountPropertyName to set.
126     */
127    public void setBaseAmountPropertyName(String baseAmountPropertyName) {
128        this.baseAmountPropertyName = baseAmountPropertyName;
129    }
130
131    /**
132     * Gets the currentAmountPropertyName attribute. 
133     * @return Returns the currentAmountPropertyName.
134     */
135    public String getCurrentAmountPropertyName() {
136        return currentAmountPropertyName;
137    }
138
139    /**
140     * Sets the currentAmountPropertyName attribute value.
141     * @param currentAmountPropertyName The currentAmountPropertyName to set.
142     */
143    public void setCurrentAmountPropertyName(String currentAmountPropertyName) {
144        this.currentAmountPropertyName = currentAmountPropertyName;
145    }
146
147    /**
148     * Gets the useShortLabels attribute. 
149     * @return Returns the useShortLabels.
150     */
151    public boolean isUseShortLabels() {
152        return useShortLabels;
153    }
154
155    /**
156     * Sets the useShortLabels attribute value.
157     * @param useShortLabels The useShortLabels to set.
158     */
159    public void setUseShortLabels(boolean useShortLabels) {
160        this.useShortLabels = useShortLabels;
161    }
162    
163}