/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2000-2001 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" and
 *     "Apache Jetspeed" must not be used to endorse or promote products
 *    derived from this software without prior written permission. For
 *    written permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache" or
 *    "Apache Jetspeed", nor may "Apache" appear in their name, without
 *    prior written permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */
 
package org.apache.jetspeed.om.profile;

import java.io.Serializable;
import java.util.Locale;
import java.util.Vector;

/**
 * Interface describing meta info for an entry. 
 *
 * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
 * @version $Id: MetaInfo.java,v 1.3 2002/09/27 16:54:07 ggolden Exp $
 */
public interface MetaInfo extends Serializable, Cloneable
{
    
    /** @return the parameter's title */
    public String getTitle();

    /** Sets the descsription of this parameter.value.
     * 
     * @param description the new title
     */
    public void setTitle(String title);

    /** @return the title specified locale for this entry */         
    public String getTitle( Locale locale );

    /** Sets the title specified locale for this entry
     * @param title the new title specified locale for this entry
     */                    
    public void setTitle( String title, Locale locale );

    /** @return value of property titles */         
    public Vector getTitles();

    /** Sets the titles for this entry
     * @param titles the new value of property titles.
     */                    
    public void setTitles( Vector titles );

    /**
     * Test if a title exists for this entry, in the specified locale.
     *
     * @param locale the title locale
     * @return true is the title exists in the specified locale
     */
    public boolean hasTitle(Locale locale);

    /** @return the parameter's description */
    public String getDescription();

    /** Sets the descsription of this parameter.value.
     * 
     * @param description the new description
     */
    public void setDescription(String description);

    /** @return the image name for this parameter */
    public String getImage();

    /** Sets the image name of this parameter.
     * 
     * @param image the new parameter value
     */
    public void setImage(String image);

    /**
     * Create a clone of this object
     */
    public Object clone()
        throws java.lang.CloneNotSupportedException;
}
