Package org.gatein.pc.api.info

Interface PortletInfo

  • public interface PortletInfo
    Runtime meta data for a portlet.
    Since:
    2.4
    Version:
    $Revision: 5448 $
    Author:
    Julien Viet

    • Method Detail

      • getName

        String getName()
        Returns the portlet name.
        Returns:
        the portlet name

      • getApplicationName

        String getApplicationName()
        Returns the portlet application name.
        Returns:
        the portlet application name

      • getCapabilities

        CapabilitiesInfo getCapabilities()
        Retrieves the capabilities of supported by the described portlet.
        Returns:
        the capabilities of the portlet

      • getPreferences

        PreferencesInfo getPreferences()
        Retrieves information about the preferences supported by the described portlet, it must return null if the portlet cannot be personalized.
        Returns:
        the preferences meta data of the portlet

      • getMeta

        MetaInfo getMeta()
        Retrieves the portlet description (title, keywords, etc).
        Returns:
        the portlet description

      • getSecurity

        SecurityInfo getSecurity()
        Retrieves the security information for the described portlet.
        Returns:
        the security information

      • getCache

        CacheInfo getCache()
        Retrieves caching-related information for the described portlet.
        Returns:
        the caching related information

      • getEventing

        EventingInfo getEventing()
        Return the eventing information.
        Returns:
        the eventing information

      • getNavigation

        NavigationInfo getNavigation()
        Returns the navigation information.
        Returns:
        the navigation information

      • getAttachment

        <T> T getAttachment​(Class<T> type)
             throws IllegalArgumentException
        Returns a generic attachment on the portlet info.
        Parameters:
        type - the parameter type
        Returns:
        the attachment or null
        Throws:
        IllegalArgumentException - if the parameter type is null

      • getRuntimeOptionsInfo

        Map<String,​RuntimeOptionInfo> getRuntimeOptionsInfo()
        Retrieves the runtime container options set by the associated portlet, if any.
        Returns:
        the runtime container options set by the associated portlet, if any