trunk/src/java/org/apache/lenya/cms/module/ModuleManager.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You under the Apache License, Version 2.0
 *  (the "License"); you may not use this file except in compliance with
 *  the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */
package org.apache.lenya.cms.module;

/**
 * Module manager.
 */
public interface ModuleManager {

    /**
     * The Avalon role.
     */
    String ROLE = ModuleManager.class.getName();
    
    /**
     * Returns the base URI of a module directory.
     * @param moduleShortcut The module shortcut.
     * @return A string.
     * @throws ModuleException if there is no module for this shortcut.
     */
    String getBaseURI(String moduleShortcut) throws ModuleException;

    /**
     * Returns a listing of all module id (shortcuts)
     * @return Map
     */
    String[] getModuleIds();
    
}