001/**
002 * Copyright 2005-2016 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.rice.kns.lookup;
017
018import java.io.IOException;
019import java.io.Writer;
020
021import javax.servlet.jsp.JspException;
022
023import org.displaytag.export.CsvView;
024import org.displaytag.model.TableModel;
025import org.kuali.rice.kns.lookup.ExportViewHelper;
026import org.kuali.rice.krad.util.KRADConstants;
027
028/**
029 * This class allows for plugging in custom CSV export into the Display Tag library. 
030 * 
031 * @author Kuali Rice Team (rice.collab@kuali.org)
032 *
033 * @deprecated KNS Struts deprecated, use KRAD and the Spring MVC framework.
034 */
035@Deprecated
036public class CustomCsvExportView extends CsvView {
037
038        private ExportViewHelper helper;
039        
040        @Override
041        public void setParameters(TableModel tableModel, boolean exportFullList,
042                        boolean includeHeader, boolean decorateValues) {
043                this.helper = new ExportViewHelper(tableModel);
044                super.setParameters(tableModel, exportFullList, includeHeader, decorateValues);
045        }
046
047        @Override
048        public void doExport(Writer writer) throws IOException, JspException {
049                if (!helper.attemptCustomExport(writer, KRADConstants.CSV_FORMAT)) {
050            // KULRICE-12281: Turn off the ability to export results from the certain lookups
051            helper.checkPermission();
052                        super.doExport(writer);
053                }
054        }
055
056}