i_cmsregistry.java

java 编写的程序

/*
* File   : $Source: /usr/local/cvs/opencms/src/com/opencms/file/I_CmsRegistry.java,v $
* Date   : $Date: 2002/02/14 14:26:42 $
* Version: $Revision: 1.26 $
*
* 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.file;

import java.util.*;
import com.opencms.core.*;

/**
 * This interface describes the registry for OpenCms.
 *
 * @author Andreas Schouten
 * @version $Revision: 1.26 $ $Date: 2002/02/14 14:26:42 $
 *
 */
public interface I_CmsRegistry extends Cloneable {
    public static final int C_ANY_VERSION = -1;

    /**
    * The name of the folder to extend the exportpath
    */
    public final String C_MODULE_PATH="modules/";

/**
 * This method clones the registry.
 *
 * @param CmsObject the current cms-object for the user.
 * @return the cloned registry.
 */
public I_CmsRegistry clone(CmsObject cms);
    /**
     * This method creates a new module in the repository.
     *
     * @param String modulename the name of the module.
     * @param String niceModulename another name of the module.
     * @param String description the description of the module.
     * @param String author the name of the author.
     * @param long createDate the creation date of the module
     * @param int version the version number of the module.
     * @throws CmsException if the user has no right to create a new module.
     */
    public void createModule(String modulename, String niceModulename, String description, String author, long createDate, int version) throws CmsException;
    /**
     * This method creates a new module in the repository.
     *
     * @param String modulename the name of the module.
     * @param String niceModulename another name of the module.
     * @param String description the description of the module.
     * @param String author the name of the author.
     * @param String createDate the creation date of the module in the format: mm.dd.yyyy
     * @param int version the version number of the module.
     * @throws CmsException if the user has no right to create a new module.
     */
    public void createModule(String modulename, String niceModulename, String description, String author, String createDate, int version) throws CmsException;
/**
 * This method checks which modules need this module. If a module depends on this the name
 * will be returned in the vector.
 * @param modulename The name of the module to check.
 * @returns a Vector with modulenames that depends on the overgiven module.
 */
public Vector deleteCheckDependencies(String modulename) throws CmsException;
/**
 * This method checks for conflicting files before the deletion of a module.
 * It uses several Vectors to return the different conflicting files.
 *
 * @param modulename the name of the module that should be deleted.
 * @param filesWithProperty a return value. The files that are marked with the module-property for this module.
 * @param missingFiles a return value. The files that are missing.
 * @param wrongChecksum a return value. The files that should be deleted but have another checksum as at import-time.
 * @param filesInUse a return value. The files that should be deleted but are in use by other modules.
 * @param resourcesForProject a return value. The files that should be copied to a project to delete.
 */
public void deleteGetConflictingFileNames(String modulename, Vector filesWithProperty, Vector missingFiles, Vector wrongChecksum, Vector filesInUse, Vector resourcesForProject) throws CmsException ;
/**
 *  Deletes a module. This method is synchronized, so only one module can be deleted at one time.
 *
 *  @param module-name the name of the module that should be deleted.
 *  @param exclusion a Vector with resource-names that should be excluded from this deletion.
 */
public void deleteModule(String module, Vector exclusion) throws CmsException;
/**
 * Deletes the view for a module.
 *
 * @param String the name of the module.
 */
public void deleteModuleView(String modulename) throws CmsException;
/**
 * This method exports a module to the filesystem.
 *
 * @param moduleName the name of the module to be exported.
 * @param String[] an array of resources to be exported.
 * @param fileName the name of the file to write the export to.
 */
public void exportModule(String moduleName, String[] resources, String fileName) throws CmsException;
/**
 * This method returns the author of the module.
 *
 * @parameter String the name of the module.
 * @return java.lang.String the author of the module.
 */
public String getModuleAuthor(String modulename);
    /**
     * This method returns the email of author of the module.
     *
     * @parameter String the name of the module.
     * @return java.lang.String the email of author of the module.
     */
    public String getModuleAuthorEmail(String modulename);
/**
 * Gets the create date of the module.
 *
 * @parameter String the name of the module.
 * @return long the create date of the module.
 */
public long getModuleCreateDate(String modulname);
/**
 * Returns the module dependencies for the module.
 *
 * @param module String the name of the module to check.
 * @param modules Vector in this parameter the names of the dependend modules will be returned.
 * @param minVersions Vector in this parameter the minimum versions of the dependend modules will be returned.
 * @param maxVersions Vector in this parameter the maximum versions of the dependend modules will be returned.
 * @return int the amount of dependencies for the module will be returned.
 */
public int getModuleDependencies(String modulename, Vector modules, Vector minVersions, Vector maxVersions);
/**
 * Returns the description of the module.
 *
 * @parameter String the name of the module.
 * @return java.lang.String the description of the module.
 */
public String getModuleDescription(String module);
/**
 * Gets the url to the documentation of the module.
 *
 * @parameter String the name of the module.
 * @return java.lang.String the url to the documentation of the module.
 */
public String getModuleDocumentPath(String modulename);
/**
 * Returns all filenames and hashcodes belonging to the module.
 *
 * @param String modulname the name of the module.
 * @param retNames the names of the resources belonging to the module.
 * @param retCodes the hashcodes of the resources belonging to the module.
 * @return the amount of entrys.
 */
public int getModuleFiles(String modulename, Vector retNames, Vector retCodes);
/**
 * Returns the class, that receives all maintenance-events for the module.
 *
 * @parameter String the name of the module.
 * @return java.lang.Class that receives all maintenance-events for the module.
 */
public Class getModuleMaintenanceEventClass(String modulname);
/**
 * Returns the name of the class, that receives all maintenance-events for the module.
 *
 * @parameter String the name of the module.
 * @return java.lang.Class that receives all maintenance-events for the module.
 */
public String getModuleMaintenanceEventName(String modulname);
/**
 * Returns the names of all available modules.
 *
 * @return String[] the names of all available modules.
 */
public Enumeration getModuleNames();
/**
 * Gets the nice name of the module.
 *
 * @param String the name of the module.
 * @returns String the nice name of the module.
 */
public String getModuleNiceName(String module);
    /**
     * Gets a parameter for a module.
     *
     * @param modulename java.lang.String the name of the module.
     * @param parameter java.lang.String the name of the parameter to set.
     * @return value java.lang.String the value to set for the parameter.
     */
    public String getModuleParameter(String modulename, String parameter);
/**
 * Returns a parameter for a module.
 *
 * @param modulname String the name of the module.
 * @param parameter String the name of the parameter.
 * @return boolean the value for the parameter in the module.
 */
public boolean getModuleParameterBoolean(String modulname, String parameter);
/**
 * Returns a parameter for a module.
 *
 * @param modulname String the name of the module.
 * @param parameter String the name of the parameter.
 * @param default the default value.
 * @return boolean the value for the parameter in the module.
 */
public Boolean getModuleParameterBoolean(String modulname, String parameter, Boolean defaultValue);
/**
 * Returns a parameter for a module.
 *
 * @param modulname String the name of the module.
 * @param parameter String the name of the parameter.
 * @param default the default value.
 * @return boolean the value for the parameter in the module.
 */
public boolean getModuleParameterBoolean(String modulname, String parameter, boolean defaultValue);
/**
 * Returns a parameter for a module.
 *
 * @param modulname String the name of the module.
 * @param parameter String the name of the parameter.
 * @param default the default value.
 * @return boolean the value for the parameter in the module.
 */
byte getModuleParameterByte(String modulname, String parameter);
/**
 * Returns a parameter for a module.
 *
 * @param modulname String the name of the module.
 * @param parameter String the name of the parameter.
 * @param default the default value.
 * @return boolean the value for the parameter in the module.
 */
public byte getModuleParameterByte(String modulname, String parameter, byte defaultValue);
/**
 * Returns a parameter for a module.
 *
 * @param modulname String the name of the module.
 * @param parameter String the name of the parameter.
 * @param default the default value.
 * @return boolean the value for the parameter in the module.