
// Copyright (c) 2001 Oracle Corporation

package oracle.portal.provider.v1;

import java.util.Locale;

/**
 * Extension (#2) to the Portlet interface.  The first extension
 * was (mis)named <code>MobilePortlet</code>.
 * <P>
 * So as to not break existing portlets new meta data is added to
 * interfaces that subclass the previous.
 *
 * @author Michael Freedman
 */
public interface PortletXtra2 extends MobilePortlet {

    /**
     * Returns the short title for the portlet.  If no short title exists
     * <code>null</code> is returned.  Clients are expected to use the
     * regular title in situations that the short title is to be used
     * but doesn't exist.
     *
     * @param The Locale the short title should be represented in.
     * @return the Portlet's short title.
     */
    public String getShortTitle(Locale l);

    /**
     * Returns the portlet's mobile settings as a bitwise flag.
     * The flags values are defined in the <code>MobileFlags</code> interface.
     *
     * @return the portlet's mobile setting in a bitwise flag
     */
    public MobileFlags getMobileFlags();

    /**
     * Returns true if this Portlet is capable of rendering content for link
     * mode.<p>
     * This method is equivalent to <code>hasShowLinkMode()</code> defined
     * in the <code>MobilePortlet</code> superclass.  It was added so its name
     * would be consistent with the other show mode accessors.
     *
     * Please use this method in lieu of <code>hasShowLinkMode()</code> which
     * is now deprecated.
     *
     *
     * @return returns true if this Portlet is capable of rendering content for
     * link mode.
     */
    public boolean hasShowLink();

}

 