i_cmsreport.java

内容管理

/*
 * File   : $Source: /usr/local/cvs/opencms/src/com/opencms/report/Attic/I_CmsReport.java,v $
 * Date   : $Date: 2003/01/29 17:23:17 $
 * Version: $Revision: 1.5 $
 *
 * This library is part of OpenCms -
 * the Open Source Content Mananagement System
 *
 * Copyright (C) 2001  The OpenCms Group
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * For further information about OpenCms, please see the
 * OpenCms Website: http://www.opencms.org
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
package com.opencms.report;

import com.opencms.linkmanagement.CmsPageLinks;

/** 
 * This is the interface for the report classes which are used to process the output
 * during database import and export operations.
 * 
 * @author Hanjo Riege
 * @author Alexander Kandzior ([e-mail]) 
 * 
 * @version $Revision: 1.5 $
 */
public interface I_CmsReport {

    // soms statics to indicate the formatting
    public static final int C_FORMAT_DEFAULT = 0;
    public static final int C_FORMAT_WARNING = 1;
    public static final int C_FORMAT_HEADLINE = 2;
    public static final int C_FORMAT_NOTE = 3;  
    public static final int C_FORMAT_OK = 4;      
        
    /** The name of the property file */
    public static final String C_BUNDLE_NAME = "com.opencms.workplace.workplace";
        
    /**
     * Adds a line break to the report.<p>
     */
    public void println();

    /**
     * Prints a String to the report.<p>
     * 
     * @param value the String to add
     */
    public void print(String value);

    /**
     * Prints a String with line break to the report.<p>
     *
     * @param value the String to add
     */
    public void println(String value);

    /**
     * Prints a String to the report, using the indicated formatting.<p>
     * 
     * Use the contants starting with <code>C_FORMAT</code> from this interface
     * to indicate which formatting to use.<p>
     *
     * @param value the String to add
     * @param format the formatting to use for the output
     */
    public void print(String value, int format);

    /**
     * Prints a String with line break to the report, using the indicated formatting.<p>
     * 
     * Use the contants starting with <code>C_FORMAT</code> from this interface
     * to indicate which formatting to use.<p>
     *
     * @param value the String to add
     * @param format the formatting to use for the output
     */
    public void println(String value, int format);
    
    /**
     * Adds a CmsPageLinks object to the report<p>
     * 
     * The object will be stored and the output will later be processed
     * in a special way.<p>
     *
     * @param value the CmsPageLinks object to add to the report
     */
    public void println(CmsPageLinks value);        

    /**
     * Adds an Exception to the report, ensuring that the Exception content is
     * processed to generate a valid output esp. for HTML pages.<p>
     * 
     * The exception will be stored and the output will later be processed
     * in a special way.<p>    
     * 
     * @param e the exception to add
     */
    public void println(Throwable t);
        
    /**
     * Updates this report, this processes all new output added since 
     * the last call to this method.<p>
     * 
     * This is only required in case the output is written to a HTML page,
     * if the shell output is used, this will just return an empty String.<p>
     * 
     * @return new elements that have been added to the report and not yet processed.
     */
    public String getReportUpdate();
    
    /**
     * Returns <code>true</code> if broken links where reported, <code>false</code>
     * otherwise.<p>
     * 
     * Open links where reported if at last one link was added to the report using the 
     * {@link #println(CmsPageLinks) } method.<p>
     * 
     * @return <code>true</code> if broken links where reported, <code>false</code>
     * otherwise
     */
    public boolean hasBrokenLinks();
    
    /**
     * Gets the localized resource string for a given message key.<p>
     * 
     * The internal implementation should be passing the
     * <code>keyName</code> to the class {@link com.opencms.flex.util.CmsMessages}.<p>
     *
     * @param keyName the key for the desired string
     * @return the resource string for the given key
     * 
     * @see com.opencms.flex.util.CmsMessages#key(String)
     */
    public String key(String keyName);
}