i_cmsregistry.java

内容管理

     *  Checks for files that already exist in the system but should be replaced by the module.
     *
     *  @param moduleZip The name of the zip-file to import.
     *  @return The complete paths to the resources that have conflicts.
     */
    public Vector importGetConflictingFileNames(String moduleZip) throws CmsException;
    
    /**
     *  Returns the name of the module to be imported.
     *
     *  @param moduleZip the name of the zip-file to import from.
     *  @return The name of the module to be imported.
     */
    public Map importGetModuleInfo(String moduleZip);   
    
    /**
     *  Returns all files that are needed to create a project for the module-import.
     *
     *  @param moduleZip The name of the zip-file to import.
     *  @return The complete paths for resources that should be in the import-project.
     */
    public Vector importGetResourcesForProject(String moduleZip) throws CmsException;
    
    /**
     *  Imports a module. This method is synchronized, so only one module can be imported at on time.
     *
     *  @param moduleZip the name of the zip-file to import from.
     *  @param exclusion a Vector with resource-names that should be excluded from this import.
     */
    public void importModule(String moduleZip, Vector exclusion, I_CmsReport report) throws CmsException;
    
    /**
     * Checks if the module exists already in the repository.
     *
     * @param String the name of the module.
     * @return true if the module exists, else false.
     */
    public boolean moduleExists(String modulename);
    
    /**
     * This method sets the author of the module.
     *
     * @param String the name of the module.
     * @param String the name of the author.
     */
    public void setModuleAuthor(String modulename, String author) throws CmsException;
    
    /**
     * This method sets the email of author of the module.
     *
     * @param String the name of the module.
     * @param String the email of author of the module.
     */
    public void setModuleAuthorEmail(String modulename, String email) throws CmsException;
    
    /**
     * Sets the create date of the module.
     *
     * @param String the name of the module.
     * @param long the create date of the module.
     */
    public void setModuleCreateDate(String modulname, long createdate) throws CmsException;
    
    /**
     * Sets the create date of the module.
     *
     * @param String the name of the module.
     * @param String the create date of the module. Format: mm.dd.yyyy
     */
    public void setModuleCreateDate(String modulname, String createdate) throws CmsException;
    
    /**
     * Sets 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.
     */
    public void setModuleDependencies(String modulename, Vector modules, Vector minVersions, Vector maxVersions)
        throws CmsException;
        
    /**
     * Sets the description of the module.
     *
     * @param String the name of the module.
     * @param String the description of the module.
     */
    public void setModuleDescription(String module, String description) throws CmsException;
    
    /**
     * Sets the url to the documentation of the module.
     *
     * @param String the name of the module.
     * @param java.lang.String the url to the documentation of the module.
     */
    public void setModuleDocumentPath(String modulename, String url) throws CmsException;
    
    /**
     * Sets the classname, that receives all maintenance-events for the module.
     *
     * @param String the name of the module.
     * @param java.lang.Class that receives all maintenance-events for the module.
     */
    public void setModuleMaintenanceEventClass(String modulname, String classname) throws CmsException;
    

    /**
     * Sets the classname, that contains the publish method of the module.
     *
     * @param String the name of the module.
     * @param String the name of the class that contains the publish method of the module.
     */
    public void setModulePublishClass(String modulname, String classname) throws CmsException;

    /**
     * Sets the description of the module.
     *
     * @param String the name of the module.
     * @param String the nice name of the module.
     */
    public void setModuleNiceName(String module, String nicename) throws CmsException;
    
    /**
     * Sets 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.
     * @param the value to set for the parameter.
     */
    public void setModuleParameter(String modulename, String parameter, byte value) throws CmsException;
    
    /**
     * Sets 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.
     * @param the value to set for the parameter.
     */
    public void setModuleParameter(String modulename, String parameter, double value) throws CmsException;
    
    /**
     * Sets 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.
     * @param the value to set for the parameter.
     */
    public void setModuleParameter(String modulename, String parameter, float value) throws CmsException;
    
    /**
     * Sets 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.
     * @param the value to set for the parameter.
     */
    public void setModuleParameter(String modulename, String parameter, int value) throws CmsException;
    
    /**
     * Sets 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.
     * @param the value to set for the parameter.
     */
    public void setModuleParameter(String modulename, String parameter, long value) throws CmsException;
    
    /**
     * Sets 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.
     * @param the value to set for the parameter.
     */
    public void setModuleParameter(String modulename, String parameter, Boolean value) throws CmsException;
    
    /**
     * Sets 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.
     * @param the value to set for the parameter.
     */
    public void setModuleParameter(String modulename, String parameter, Byte value) throws CmsException;
    
    /**
     * Sets 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.
     * @param the value to set for the parameter.
     */
    public void setModuleParameter(String modulename, String parameter, Double value) throws CmsException;
    
    /**
     * Sets 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.
     * @param the value to set for the parameter.
     */
    public void setModuleParameter(String modulename, String parameter, Float value) throws CmsException;
    
    /**
     * Sets 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.
     * @param the value to set for the parameter.
     */
    public void setModuleParameter(String modulename, String parameter, Integer value) throws CmsException;
    
    /**
     * Sets 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.
     * @param the value to set for the parameter.
     */
    public void setModuleParameter(String modulename, String parameter, Long value) throws CmsException;
    
    /**
     * Sets 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.
     * @param value java.lang.String the value to set for the parameter.
     */
    public void setModuleParameter(String modulename, String parameter, String value) throws CmsException;
    
    /**
     * Sets 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.
     * @param the value to set for the parameter.
     */
    public void setModuleParameter(String modulename, String parameter, boolean value) throws CmsException;
    
    /**
     * Sets the module dependencies for the module.
     *
     * @param module String the name of the module to check.
     * @param names Vector with parameternames
     * @param descriptions Vector with parameterdescriptions
     * @param types Vector with parametertypes (string, float,...)
     * @param values Vector with defaultvalues for parameters
     */
    public void setModuleParameterdef(
        String modulename,
        Vector names,
        Vector descriptions,
        Vector types,
        Vector values)
        throws CmsException;
        
    /**
     * Sets all repositories for a module.
     *
     * @param String modulname the name of the module.
     * @param String[] the reprositories of a module.
     */
    public void setModuleRepositories(String modulename, String[] repositories) throws CmsException;
    
    /**
     * This method sets the version of the module.
     *
     * @param modulename the name of the module.
     * @param version the version of the module.
     */
    public void setModuleVersion(String modulename, String version) throws CmsException;
    
    /**
     * Sets a view for a module
     *
     * @param String the name of the module.
     * @param String the name of the view, that is implemented by the module.
     * @param String the url of the view, that is implemented by the module.
     */
    public void setModuleView(String modulename, String viewname, String viewurl) throws CmsException;

    /**
     * Public method to set system values.
     *
     * @param String dataName the name of the tag to set the data for.
     * @param String the value to be set.
     */
    public void setSystemValue(String dataName, String value) throws CmsException;

    /**
     * Public method to set system values with hashtable.
     *
     * @param String dataName the name of the tag to set the data for.
     * @param Hashtable the value to be set.
     */
    public void setSystemValues(String dataName, Hashtable values) throws CmsException;

    /**
     * Returns all exportpoints and paths.
     *
     *
     * @return Hashtable The exportpoints and the paths.
     */
    public Hashtable getExportpoints();

    /**
     * Returns the value of the "type" node of a module subtree in the registry.
     * @return the value of the "type" node of a module
     */
    public String getModuleType(String theModulename);

    /**
     * Sets the type for a given module.
     * @param theModuleName the name of the module
     * @param theModuleType the new type of the module
     */
    public void setModuleType(String theModulename, String theModuleType);
}