1 /* 2 * Copyright (c) 2002-2018, Mairie de Paris 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 9 * 1. Redistributions of source code must retain the above copyright notice 10 * and the following disclaimer. 11 * 12 * 2. Redistributions in binary form must reproduce the above copyright notice 13 * and the following disclaimer in the documentation and/or other materials 14 * provided with the distribution. 15 * 16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its 17 * contributors may be used to endorse or promote products derived from 18 * this software without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE 24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 * POSSIBILITY OF SUCH DAMAGE. 31 * 32 * License 1.0 33 */ 34 package fr.paris.lutece.plugins.directory.modules.multiview.web.record.column.display; 35 36 import java.util.Locale; 37 38 import fr.paris.lutece.plugins.directory.modules.multiview.business.record.column.IRecordColumn; 39 import fr.paris.lutece.plugins.directory.modules.multiview.business.record.column.RecordColumnCell; 40 import fr.paris.lutece.plugins.directory.modules.multiview.web.record.util.IRecordListPosition; 41 42 /** 43 * Interface for a RecordColumnDisplay objects 44 */ 45 public interface IRecordColumnDisplay extends IRecordListPosition 46 { 47 /** 48 * Return the header template of the RecordColumn 49 * 50 * @return the header template of the RecordColumn 51 */ 52 String getRecordColumnHeaderTemplate( ); 53 54 /** 55 * Build the header template of the RecordColumn 56 * 57 * @param strSortUrl 58 * The url used to sort the column 59 * @param locale 60 * The locale to use to build the template 61 * @return the record column header template 62 */ 63 String buildRecordColumnHeaderTemplate( String strSortUrl, Locale locale ); 64 65 /** 66 * Build the template of the given RecordColumnCell for the RecordColumn 67 * 68 * @param recordColumnCell 69 * The RecordColumnCell to use for build the template of the RecordColumnDisplay 70 * @param locale 71 * The locale to use for build the template 72 * @return the template of the given RecordColumnCell 73 */ 74 String buildRecordColumnCellTemplate( RecordColumnCell recordColumnCell, Locale locale ); 75 76 /** 77 * Return the RecordColumn object associated to the RecordColumnDisplay 78 * 79 * @return the RecordColumn object associated to the RecordColumnDisplay 80 */ 81 IRecordColumn getRecordColumn( ); 82 83 /** 84 * Set the RecordColumn associated to the current RecordColumnDisplay 85 * 86 * @param recordColumn 87 * The RecordColumn to associate to the RecordColumnDisplay 88 */ 89 void setRecordColumn( IRecordColumn recordColumn ); 90 }