RELEASE_2_1_13/src/blocks/portal/java/org/apache/cocoon/portal/aspect/AspectDescription.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.cocoon.portal.aspect;


/**
 * A configured aspect for an {@link Aspectalizable} object
 * 
 * @author <a href="mailto:cziegeler@s-und-n.de">Carsten Ziegeler</a>
 * 
 * @version CVS $Id$
 */
public interface AspectDescription  {

    /**
     * @return The class name of the data
     */
    String getClassName();

    /**
     * @return The name of the aspect
     */
    String getName();

    /**
     * @return The name (role) of the store to store the data
     */
    String getStoreName();
    
    /**
     * If the data is not available, create it automatically (or not)
     */
    boolean isAutoCreate();
    
    /**
     * Default value
     */
    String getDefaultValue();

}