/*
 * Copyright 2008 The Kuali Foundation
 * 
 * Licensed under the Educational Community License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.opensource.org/licenses/ecl2.php
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.kuali.ole.sys.document.datadictionary;

import java.util.Comparator;
import java.util.List;
import java.util.Map;

import org.kuali.ole.sys.businessobject.AccountingLine;
import org.kuali.ole.sys.document.AccountingDocument;
import org.kuali.ole.sys.document.authorization.AccountingLineAuthorizer;
import org.kuali.ole.sys.document.web.DefaultAccountingLineGroupImpl;
import org.kuali.ole.sys.document.web.RenderableAccountingLineContainer;
import org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase;
import org.kuali.rice.krad.datadictionary.exception.AttributeValidationException;

/**
 * Data dictionary definition that includes metadata for an accounting document about one of its groups of accounting lines (typically source vs. target, but this should open things up).
 */
public class AccountingLineGroupDefinition extends DataDictionaryDefinitionBase {
    private String groupLabel;
    private Class<? extends AccountingLine> accountingLineClass;
    private AccountingLineViewDefinition accountingLineView;
    private String importedLinePropertyPrefix;
    private List<? extends TotalDefinition> totals;
    private Class<? extends AccountingLineAuthorizer> accountingLineAuthorizerClass;
    private int forceColumnCount = -1;
    private String errorKey;
    private boolean topHeadersAfterFirstLineHiding = true;
    private boolean headerRendering = true;
    private boolean importingAllowed = true;
    private Class<? extends DefaultAccountingLineGroupImpl> accountingLineGroupClass = org.kuali.ole.sys.document.web.DefaultAccountingLineGroupImpl.class;
    private Class<? extends Comparator<AccountingLine>> accountingLineComparatorClass = org.kuali.ole.sys.businessobject.AccountingLineComparator.class;
    
    private List<? extends AccountingLineViewActionDefinition> accountingLineGroupActions;
    
    private AccountingLineAuthorizer accountingLineAuthorizer;

    /**
     * Validates that:
     * 1) this accounting line group has an accounting line class
     * 2) this accounting line group has an accounting line view 
     * @see org.kuali.rice.krad.datadictionary.DataDictionaryDefinition#completeValidation(java.lang.Class, java.lang.Class)
     */
    public void completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass) {
        if (accountingLineClass == null) {
            throw new AttributeValidationException("Please specify an accounting line class for AccountingLineGroup "+getId());
        }
        if (accountingLineView == null) {
            throw new AttributeValidationException("Please specify an accountingLineView for AccountingLineGroup "+getId());
        }
    }

    /**
     * Gets the accountingLineClass attribute. 
     * @return Returns the accountingLineClass.
     */
    public Class<? extends AccountingLine> getAccountingLineClass() {
        return accountingLineClass;
    }

    /**
     * Sets the accountingLineClass attribute value.
     * @param accountingLineClass The accountingLineClass to set.
     */
    public void setAccountingLineClass(Class<? extends AccountingLine> accountingLineClass) {
        this.accountingLineClass = accountingLineClass;
    }

    /**
     * Gets the accountingLineView attribute. 
     * @return Returns the accountingLineView.
     */
    public AccountingLineViewDefinition getAccountingLineView() {
        return accountingLineView;
    }

    /**
     * Sets the accountingLineView attribute value.
     * @param accountingLineView The accountingLineView to set.
     */
    public void setAccountingLineView(AccountingLineViewDefinition accountingLineView) {
        this.accountingLineView = accountingLineView;
    }

    /**
     * Gets the groupLabel attribute. 
     * @return Returns the groupLabel.
     */
    public String getGroupLabel() {
        return (groupLabel == null) ? "" : groupLabel;
    }

    /**
     * Sets the groupLabel attribute value.
     * @param groupLabel The groupLabel to set.
     */
    public void setGroupLabel(String groupLabel) {
        this.groupLabel = groupLabel;
    }

    /**
     * Gets the totals attribute. 
     * @return Returns the totals.
     */
    public List<? extends TotalDefinition> getTotals() {
        return totals;
    }

    /**
     * Sets the totals attribute value.
     * @param totals The totals to set.
     */
    public void setTotals(List<? extends TotalDefinition> totals) {
        this.totals = totals;
    }

    /**
     * Gets the accountingLineAuthorizerClass attribute. 
     * @return Returns the accountingLineAuthorizerClass.
     */
    public Class<? extends AccountingLineAuthorizer> getAccountingLineAuthorizerClass() {
        return accountingLineAuthorizerClass;
    }

    /**
     * Sets the accountingLineAuthorizerClass attribute value.
     * @param accountingLineAuthorizerClass The accountingLineAuthorizerClass to set.
     */
    public void setAccountingLineAuthorizerClass(Class<? extends AccountingLineAuthorizer> accountingLineAuthorizerClass) {
        this.accountingLineAuthorizerClass = accountingLineAuthorizerClass;
    }
    
    /**
     * Gets the importedLinePropertyPrefix attribute. 
     * @return Returns the importedLinePropertyPrefix.
     */
    public String getImportedLinePropertyPrefix() {
        return importedLinePropertyPrefix;
    }

    /**
     * Sets the importedLinePropertyPrefix attribute value.
     * @param importedLinePropertyPrefix The importedLinePropertyPrefix to set.
     */
    public void setImportedLinePropertyPrefix(String importedLinePropertyPrefix) {
        this.importedLinePropertyPrefix = importedLinePropertyPrefix;
    }

    /**
     * Gets the forceColumnCount attribute. 
     * @return Returns the forceColumnCount.
     */
    public int getForceColumnCount() {
        return forceColumnCount;
    }

    /**
     * Sets the forceColumnCount attribute value.
     * @param forceColumnCount The forceColumnCount to set.
     */
    public void setForceColumnCount(int forceColumnCount) {
        this.forceColumnCount = forceColumnCount;
    }

    /**
     * Gets the errorKey attribute. 
     * @return Returns the errorKey.
     */
    public String getErrorKey() {
        return errorKey;
    }

    /**
     * Sets the errorKey attribute value.
     * @param errorKey The errorKey to set.
     */
    public void setErrorKey(String errorKey) {
        this.errorKey = errorKey;
    }

    /**
     * Returns an instance of the accounting line authorizer for this group
     * @return an instance of the accounting line authorizer
     */
    public AccountingLineAuthorizer getAccountingLineAuthorizer() {
        if (accountingLineAuthorizer == null) {
            accountingLineAuthorizer = createAccountingLineAuthorizer();
        }
        return accountingLineAuthorizer;
    }
    
    /**
     * Creates an instance of the accounting line authorizer
     * @return the accounting line authorizer for this group
     */
    protected AccountingLineAuthorizer createAccountingLineAuthorizer() {
        Class<? extends AccountingLineAuthorizer> authorizerClass = getAccountingLineAuthorizerClass();
        AccountingLineAuthorizer authorizer = null;
        try {
            authorizer = authorizerClass.newInstance();
        }
        catch (InstantiationException ie) {
            throw new IllegalArgumentException("InstantiationException while attempting to instantiate AccountingLineAuthorization class", ie);
        }
        catch (IllegalAccessException iae) {
            throw new IllegalArgumentException("IllegalAccessException while attempting to instantiate AccountingLineAuthorization class", iae);
        }
        return authorizer;
    }

    /**
     * Gets the topHeadersAfterFirstLineHiding attribute. 
     * @return Returns the topHeadersAfterFirstLineHiding.
     */
    public boolean isTopHeadersAfterFirstLineHiding() {
        return topHeadersAfterFirstLineHiding;
    }

    /**
     * Sets the topHeadersAfterFirstLineHiding attribute value.
     * @param topHeadersAfterFirstLineHiding The topHeadersAfterFirstLineHiding to set.
     */
    public void setTopHeadersAfterFirstLineHiding(boolean showTopHeadersAfterFirstLine) {
        this.topHeadersAfterFirstLineHiding = showTopHeadersAfterFirstLine;
    }

    /**
     * Gets the headerRendering attribute. 
     * @return Returns the headerRendering.
     */
    public boolean isHeaderRendering() {
        return headerRendering;
    }

    /**
     * Sets the headerRendering attribute value.
     * @param headerRendering The headerRendering to set.
     */
    public void setHeaderRendering(boolean headerRendering) {
        this.headerRendering = headerRendering;
    }

    /**
     * Gets the accountingLineGroupActions attribute. 
     * @return Returns the accountingLineGroupActions.
     */
    public List<? extends AccountingLineViewActionDefinition> getAccountingLineGroupActions() {
        return accountingLineGroupActions;
    }

    /**
     * Sets the accountingLineGroupActions attribute value.
     * @param accountingLineGroupActions The accountingLineGroupActions to set.
     */
    public void setAccountingLineGroupActions(List<? extends AccountingLineViewActionDefinition> accountingLineGroupActions) {
        this.accountingLineGroupActions = accountingLineGroupActions;
    }

    /**
     * Gets the importingAllowed attribute. 
     * @return Returns the importingAllowed.
     */
    public boolean isImportingAllowed() {
        return importingAllowed;
    }

    /**
     * Sets the importingAllowed attribute value.
     * @param importingAllowed The importingAllowed to set.
     */
    public void setImportingAllowed(boolean importingAllowed) {
        this.importingAllowed = importingAllowed;
    }

    /**
     * Gets the accountingLineGroupClass attribute. 
     * @return Returns the accountingLineGroupClass.
     */
    public Class<? extends DefaultAccountingLineGroupImpl> getAccountingLineGroupClass() {
        return accountingLineGroupClass;
    }

    /**
     * Sets the accountingLineGroupClass attribute value.
     * @param accountingLineGroupClass The accountingLineGroupClass to set.
     */
    public void setAccountingLineGroupClass(Class<? extends DefaultAccountingLineGroupImpl> accountingLineGroupClass) {
        this.accountingLineGroupClass = accountingLineGroupClass;
    }
    
    /**
     * Sets the accountingLineComparatorClass attribute value.
     * @param accountingLineComparatorClass The accountingLineComparatorClass to set.
     */
    public void setAccountingLineComparatorClass(Class<? extends Comparator<AccountingLine>> accountingLineComparatorClass) {
        this.accountingLineComparatorClass = accountingLineComparatorClass;
    }
    
    /**
     * @return an instance of the Comparator this group should use to sort accounting lines
     */
    public Comparator<AccountingLine> getAccountingLineComparator() {
        Comparator<AccountingLine> comparator = null;
        try {
            comparator = accountingLineComparatorClass.newInstance();
        }
        catch (InstantiationException ie) {
            throw new RuntimeException("Could not instantiate class for AccountingLineComparator for group", ie);
        }
        catch (IllegalAccessException iae) {
            throw new RuntimeException("Illegal access attempting to instantiate class for AccountingLineComparator for group", iae);
        }
        return comparator;
    }

    /**
     * Creates a new accounting line group for this definition
     * @param accountingDocument the document which owns or will own the accounting line being rendered
     * @param containers the containers within this group
     * @param collectionPropertyName the property name of the collection of accounting lines owned by this group
     * @param errors a List of errors keys for errors on the page
     * @param displayedErrors a Map of errors that have already been displayed
     * @param canEdit determines if the page can be edited or not
     * @return a newly created and initialized accounting line group
     */
    public DefaultAccountingLineGroupImpl createAccountingLineGroup(AccountingDocument accountingDocument, List<RenderableAccountingLineContainer> containers, String collectionPropertyName, String collectionItemPropertyName, Map<String, Object> displayedErrors, Map<String, Object> displayedWarnings, Map<String, Object> displayedInfo, boolean canEdit) {
        DefaultAccountingLineGroupImpl accountingLineGroup = null;
        try {
            accountingLineGroup = getAccountingLineGroupClass().newInstance();
            accountingLineGroup.initialize(this, accountingDocument, containers, collectionPropertyName, collectionItemPropertyName, displayedErrors, displayedWarnings, displayedInfo, canEdit);
        }
        catch (InstantiationException ie) {
            throw new RuntimeException("Could not initialize new AccountingLineGroup implementation of class: "+getAccountingLineGroupClass().getName(), ie);
        }
        catch (IllegalAccessException iae) {
            throw new RuntimeException("Could not initialize new AccountingLineGroup implementation of class: "+getAccountingLineGroupClass().getName(), iae);
        }
        return accountingLineGroup;
    }
}